blob: e67ddcdd116025df7c13d51cf5955a7ec374cf76 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-rustls-0.22.0/src/client.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>client.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../tokio_rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../tokio_rustls/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
</pre><pre class="rust"><code><span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::common::IoSession;
<span class="kw">use </span>rustls::Session;
<span class="doccomment">/// A wrapper around an underlying raw stream which implements the TLS or SSL
/// protocol.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>TlsStream&lt;IO&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) io: IO,
<span class="kw">pub</span>(<span class="kw">crate</span>) session: ClientSession,
<span class="kw">pub</span>(<span class="kw">crate</span>) state: TlsState,
}
<span class="kw">impl</span>&lt;IO&gt; TlsStream&lt;IO&gt; {
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (<span class="kw-2">&amp;</span>IO, <span class="kw-2">&amp;</span>ClientSession) {
(<span class="kw-2">&amp;</span><span class="self">self</span>.io, <span class="kw-2">&amp;</span><span class="self">self</span>.session)
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; (<span class="kw-2">&amp;mut </span>IO, <span class="kw-2">&amp;mut </span>ClientSession) {
(<span class="kw-2">&amp;mut </span><span class="self">self</span>.io, <span class="kw-2">&amp;mut </span><span class="self">self</span>.session)
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -&gt; (IO, ClientSession) {
(<span class="self">self</span>.io, <span class="self">self</span>.session)
}
}
<span class="kw">impl</span>&lt;IO&gt; IoSession <span class="kw">for </span>TlsStream&lt;IO&gt; {
<span class="kw">type </span>Io = IO;
<span class="kw">type </span>Session = ClientSession;
<span class="attribute">#[inline]
</span><span class="kw">fn </span>skip_handshake(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.state.is_early_data()
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>get_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; (<span class="kw-2">&amp;mut </span>TlsState, <span class="kw-2">&amp;mut </span><span class="self">Self</span>::Io, <span class="kw-2">&amp;mut </span><span class="self">Self</span>::Session) {
(<span class="kw-2">&amp;mut </span><span class="self">self</span>.state, <span class="kw-2">&amp;mut </span><span class="self">self</span>.io, <span class="kw-2">&amp;mut </span><span class="self">self</span>.session)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>into_io(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Io {
<span class="self">self</span>.io
}
}
<span class="kw">impl</span>&lt;IO&gt; AsyncRead <span class="kw">for </span>TlsStream&lt;IO&gt;
<span class="kw">where
</span>IO: AsyncRead + AsyncWrite + Unpin,
{
<span class="kw">fn </span>poll_read(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
buf: <span class="kw-2">&amp;mut </span>ReadBuf&lt;<span class="lifetime">&#39;_</span>&gt;,
) -&gt; Poll&lt;io::Result&lt;()&gt;&gt; {
<span class="kw">match </span><span class="self">self</span>.state {
<span class="attribute">#[cfg(feature = <span class="string">&quot;early-data&quot;</span>)]
</span>TlsState::EarlyData(..) =&gt; Poll::Pending,
TlsState::Stream | TlsState::WriteShutdown =&gt; {
<span class="kw">let </span>this = <span class="self">self</span>.get_mut();
<span class="kw">let </span><span class="kw-2">mut </span>stream =
Stream::new(<span class="kw-2">&amp;mut </span>this.io, <span class="kw-2">&amp;mut </span>this.session).set_eof(!this.state.readable());
<span class="kw">let </span>prev = buf.remaining();
<span class="kw">match </span>stream.as_mut_pin().poll_read(cx, buf) {
Poll::Ready(<span class="prelude-val">Ok</span>(())) =&gt; {
<span class="kw">if </span>prev == buf.remaining() {
this.state.shutdown_read();
}
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
Poll::Ready(<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e)) <span class="kw">if </span>e.kind() == io::ErrorKind::ConnectionAborted =&gt; {
this.state.shutdown_read();
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
output =&gt; output,
}
}
TlsState::ReadShutdown | TlsState::FullyShutdown =&gt; Poll::Ready(<span class="prelude-val">Ok</span>(())),
}
}
}
<span class="kw">impl</span>&lt;IO&gt; AsyncWrite <span class="kw">for </span>TlsStream&lt;IO&gt;
<span class="kw">where
</span>IO: AsyncRead + AsyncWrite + Unpin,
{
<span class="doccomment">/// Note: that it does not guarantee the final data to be sent.
/// To be cautious, you must manually call `flush`.
</span><span class="kw">fn </span>poll_write(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
buf: <span class="kw-2">&amp;</span>[u8],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
<span class="kw">let </span>this = <span class="self">self</span>.get_mut();
<span class="kw">let </span><span class="kw-2">mut </span>stream =
Stream::new(<span class="kw-2">&amp;mut </span>this.io, <span class="kw-2">&amp;mut </span>this.session).set_eof(!this.state.readable());
<span class="attribute">#[allow(clippy::match_single_binding)]
</span><span class="kw">match </span>this.state {
<span class="attribute">#[cfg(feature = <span class="string">&quot;early-data&quot;</span>)]
</span>TlsState::EarlyData(<span class="kw-2">ref mut </span>pos, <span class="kw-2">ref mut </span>data) =&gt; {
<span class="kw">use </span>std::io::Write;
<span class="comment">// write early data
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">mut </span>early_data) = stream.session.early_data() {
<span class="kw">let </span>len = <span class="kw">match </span>early_data.write(buf) {
<span class="prelude-val">Ok</span>(n) =&gt; n,
<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock =&gt; {
<span class="kw">return </span>Poll::Pending
}
<span class="prelude-val">Err</span>(err) =&gt; <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(err)),
};
<span class="kw">if </span>len != <span class="number">0 </span>{
data.extend_from_slice(<span class="kw-2">&amp;</span>buf[..len]);
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">Ok</span>(len));
}
}
<span class="comment">// complete handshake
</span><span class="kw">while </span>stream.session.is_handshaking() {
<span class="macro">ready!</span>(stream.handshake(cx))<span class="question-mark">?</span>;
}
<span class="comment">// write early data (fallback)
</span><span class="kw">if </span>!stream.session.is_early_data_accepted() {
<span class="kw">while </span><span class="kw-2">*</span>pos &lt; data.len() {
<span class="kw">let </span>len = <span class="macro">ready!</span>(stream.as_mut_pin().poll_write(cx, <span class="kw-2">&amp;</span>data[<span class="kw-2">*</span>pos..]))<span class="question-mark">?</span>;
<span class="kw-2">*</span>pos += len;
}
}
<span class="comment">// end
</span>this.state = TlsState::Stream;
stream.as_mut_pin().poll_write(cx, buf)
}
<span class="kw">_ </span>=&gt; stream.as_mut_pin().poll_write(cx, buf),
}
}
<span class="kw">fn </span>poll_flush(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;io::Result&lt;()&gt;&gt; {
<span class="kw">let </span>this = <span class="self">self</span>.get_mut();
<span class="kw">let </span><span class="kw-2">mut </span>stream =
Stream::new(<span class="kw-2">&amp;mut </span>this.io, <span class="kw-2">&amp;mut </span>this.session).set_eof(!this.state.readable());
<span class="attribute">#[cfg(feature = <span class="string">&quot;early-data&quot;</span>)]
</span>{
<span class="kw">if let </span>TlsState::EarlyData(<span class="kw-2">ref mut </span>pos, <span class="kw-2">ref mut </span>data) = this.state {
<span class="comment">// complete handshake
</span><span class="kw">while </span>stream.session.is_handshaking() {
<span class="macro">ready!</span>(stream.handshake(cx))<span class="question-mark">?</span>;
}
<span class="comment">// write early data (fallback)
</span><span class="kw">if </span>!stream.session.is_early_data_accepted() {
<span class="kw">while </span><span class="kw-2">*</span>pos &lt; data.len() {
<span class="kw">let </span>len = <span class="macro">ready!</span>(stream.as_mut_pin().poll_write(cx, <span class="kw-2">&amp;</span>data[<span class="kw-2">*</span>pos..]))<span class="question-mark">?</span>;
<span class="kw-2">*</span>pos += len;
}
}
this.state = TlsState::Stream;
}
}
stream.as_mut_pin().poll_flush(cx)
}
<span class="kw">fn </span>poll_shutdown(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;io::Result&lt;()&gt;&gt; {
<span class="kw">if </span><span class="self">self</span>.state.writeable() {
<span class="self">self</span>.session.send_close_notify();
<span class="self">self</span>.state.shutdown_write();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;early-data&quot;</span>)]
</span>{
<span class="comment">// we skip the handshake
</span><span class="kw">if let </span>TlsState::EarlyData(..) = <span class="self">self</span>.state {
<span class="kw">return </span>Pin::new(<span class="kw-2">&amp;mut </span><span class="self">self</span>.io).poll_shutdown(cx);
}
}
<span class="kw">let </span>this = <span class="self">self</span>.get_mut();
<span class="kw">let </span><span class="kw-2">mut </span>stream =
Stream::new(<span class="kw-2">&amp;mut </span>this.io, <span class="kw-2">&amp;mut </span>this.session).set_eof(!this.state.readable());
stream.as_mut_pin().poll_shutdown(cx)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio_rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>