blob: a931dc442553abb30df7cabddd75aeeedd4571cd [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-native-tls-0.3.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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_native_tls/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_native_tls/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>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
</pre><pre class="rust"><code><span class="attribute">#![doc(html_root_url = <span class="string">&quot;https://docs.rs/tokio-native-tls/0.3.0&quot;</span>)]
#![warn(
missing_debug_implementations,
missing_docs,
rust_2018_idioms,
unreachable_pub
)]
#![deny(rustdoc::broken_intra_doc_links)]
#![doc(test(
no_crate_inject,
attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
))]
</span><span class="doccomment">//! Async TLS streams
//!
//! This library is an implementation of TLS streams using the most appropriate
//! system library by default for negotiating the connection. That is, on
//! Windows this library uses SChannel, on OSX it uses SecureTransport, and on
//! other platforms it uses OpenSSL.
//!
//! Each TLS stream implements the `Read` and `Write` traits to interact and
//! interoperate with the rest of the futures I/O ecosystem. Client connections
//! initiated from this crate verify hostnames automatically and by default.
//!
//! This crate primarily exports this ability through two newtypes,
//! `TlsConnector` and `TlsAcceptor`. These newtypes augment the
//! functionality provided by the `native-tls` crate, on which this crate is
//! built. Configuration of TLS parameters is still primarily done through the
//! `native-tls` crate.
</span><span class="kw">use </span>tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
<span class="kw">use </span><span class="kw">crate</span>::native_tls::{Error, HandshakeError, MidHandshakeTlsStream};
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::future::Future;
<span class="kw">use </span>std::io::{<span class="self">self</span>, Read, Write};
<span class="kw">use </span>std::marker::Unpin;
<span class="attribute">#[cfg(unix)]
</span><span class="kw">use </span>std::os::unix::io::{AsRawFd, RawFd};
<span class="attribute">#[cfg(windows)]
</span><span class="kw">use </span>std::os::windows::io::{AsRawSocket, RawSocket};
<span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>std::ptr::null_mut;
<span class="kw">use </span>std::task::{Context, Poll};
<span class="doccomment">/// An intermediate wrapper for the inner stream `S`.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>AllowStd&lt;S&gt; {
inner: S,
context: <span class="kw-2">*mut </span>(),
}
<span class="kw">impl</span>&lt;S&gt; AllowStd&lt;S&gt; {
<span class="doccomment">/// Returns a shared reference to the inner stream.
</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>S {
<span class="kw-2">&amp;</span><span class="self">self</span>.inner
}
<span class="doccomment">/// Returns a mutable reference to the inner stream.
</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>S {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.inner
}
}
<span class="doccomment">/// A wrapper around an underlying raw stream which implements the TLS or SSL
/// protocol.
///
/// A `TlsStream&lt;S&gt;` represents a handshake that has been completed successfully
/// and both the server and the client are ready for receiving and sending
/// data. Bytes read from a `TlsStream` are decrypted from `S` and bytes written
/// to a `TlsStream` are encrypted when passing through to `S`.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>TlsStream&lt;S&gt;(native_tls::TlsStream&lt;AllowStd&lt;S&gt;&gt;);
<span class="doccomment">/// A wrapper around a `native_tls::TlsConnector`, providing an async `connect`
/// method.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>TlsConnector(native_tls::TlsConnector);
<span class="doccomment">/// A wrapper around a `native_tls::TlsAcceptor`, providing an async `accept`
/// method.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>TlsAcceptor(native_tls::TlsAcceptor);
<span class="kw">struct </span>MidHandshake&lt;S&gt;(<span class="prelude-ty">Option</span>&lt;MidHandshakeTlsStream&lt;AllowStd&lt;S&gt;&gt;&gt;);
<span class="kw">enum </span>StartedHandshake&lt;S&gt; {
Done(TlsStream&lt;S&gt;),
Mid(MidHandshakeTlsStream&lt;AllowStd&lt;S&gt;&gt;),
}
<span class="kw">struct </span>StartedHandshakeFuture&lt;F, S&gt;(<span class="prelude-ty">Option</span>&lt;StartedHandshakeFutureInner&lt;F, S&gt;&gt;);
<span class="kw">struct </span>StartedHandshakeFutureInner&lt;F, S&gt; {
f: F,
stream: S,
}
<span class="kw">struct </span>Guard&lt;<span class="lifetime">&#39;a</span>, S&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>TlsStream&lt;S&gt;)
<span class="kw">where
</span>AllowStd&lt;S&gt;: Read + Write;
<span class="kw">impl</span>&lt;S&gt; Drop <span class="kw">for </span>Guard&lt;<span class="lifetime">&#39;_</span>, S&gt;
<span class="kw">where
</span>AllowStd&lt;S&gt;: Read + Write,
{
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
(<span class="self">self</span>.<span class="number">0</span>).<span class="number">0</span>.get_mut().context = null_mut();
}
}
<span class="comment">// *mut () context is neither Send nor Sync
</span><span class="kw">unsafe impl</span>&lt;S: Send&gt; Send <span class="kw">for </span>AllowStd&lt;S&gt; {}
<span class="kw">unsafe impl</span>&lt;S: Sync&gt; Sync <span class="kw">for </span>AllowStd&lt;S&gt; {}
<span class="kw">impl</span>&lt;S&gt; AllowStd&lt;S&gt;
<span class="kw">where
</span>S: Unpin,
{
<span class="kw">fn </span>with_context&lt;F, R&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, f: F) -&gt; io::Result&lt;R&gt;
<span class="kw">where
</span>F: FnOnce(<span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;, Pin&lt;<span class="kw-2">&amp;mut </span>S&gt;) -&gt; Poll&lt;io::Result&lt;R&gt;&gt;,
{
<span class="kw">unsafe </span>{
<span class="macro">assert!</span>(!<span class="self">self</span>.context.is_null());
<span class="kw">let </span>waker = <span class="kw-2">&amp;mut *</span>(<span class="self">self</span>.context <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>);
<span class="kw">match </span>f(waker, Pin::new(<span class="kw-2">&amp;mut </span><span class="self">self</span>.inner)) {
Poll::Ready(r) =&gt; r,
Poll::Pending =&gt; <span class="prelude-val">Err</span>(io::Error::from(io::ErrorKind::WouldBlock)),
}
}
}
}
<span class="kw">impl</span>&lt;S&gt; Read <span class="kw">for </span>AllowStd&lt;S&gt;
<span class="kw">where
</span>S: AsyncRead + Unpin,
{
<span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = ReadBuf::new(buf);
<span class="self">self</span>.with_context(|ctx, stream| stream.poll_read(ctx, <span class="kw-2">&amp;mut </span>buf))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(buf.filled().len())
}
}
<span class="kw">impl</span>&lt;S&gt; Write <span class="kw">for </span>AllowStd&lt;S&gt;
<span class="kw">where
</span>S: AsyncWrite + Unpin,
{
<span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<span class="self">self</span>.with_context(|ctx, stream| stream.poll_write(ctx, buf))
}
<span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.with_context(|ctx, stream| stream.poll_flush(ctx))
}
}
<span class="kw">impl</span>&lt;S&gt; TlsStream&lt;S&gt; {
<span class="kw">fn </span>with_context&lt;F, R&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, ctx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;, f: F) -&gt; Poll&lt;io::Result&lt;R&gt;&gt;
<span class="kw">where
</span>F: FnOnce(<span class="kw-2">&amp;mut </span>native_tls::TlsStream&lt;AllowStd&lt;S&gt;&gt;) -&gt; io::Result&lt;R&gt;,
AllowStd&lt;S&gt;: Read + Write,
{
<span class="self">self</span>.<span class="number">0</span>.get_mut().context = ctx <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ as </span><span class="kw-2">*mut </span>();
<span class="kw">let </span>g = Guard(<span class="self">self</span>);
<span class="kw">match </span>f(<span class="kw-2">&amp;mut </span>(g.<span class="number">0</span>).<span class="number">0</span>) {
<span class="prelude-val">Ok</span>(v) =&gt; Poll::Ready(<span class="prelude-val">Ok</span>(v)),
<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock =&gt; Poll::Pending,
<span class="prelude-val">Err</span>(e) =&gt; Poll::Ready(<span class="prelude-val">Err</span>(e)),
}
}
<span class="doccomment">/// Returns a shared reference to the inner stream.
</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>native_tls::TlsStream&lt;AllowStd&lt;S&gt;&gt; {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0
</span>}
<span class="doccomment">/// Returns a mutable reference to the inner stream.
</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>native_tls::TlsStream&lt;AllowStd&lt;S&gt;&gt; {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.<span class="number">0
</span>}
}
<span class="kw">impl</span>&lt;S&gt; AsyncRead <span class="kw">for </span>TlsStream&lt;S&gt;
<span class="kw">where
</span>S: AsyncRead + AsyncWrite + Unpin,
{
<span class="kw">fn </span>poll_read(
<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;,
ctx: <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="self">self</span>.with_context(ctx, |s| {
<span class="kw">let </span>n = s.read(buf.initialize_unfilled())<span class="question-mark">?</span>;
buf.advance(n);
<span class="prelude-val">Ok</span>(())
})
}
}
<span class="kw">impl</span>&lt;S&gt; AsyncWrite <span class="kw">for </span>TlsStream&lt;S&gt;
<span class="kw">where
</span>S: AsyncRead + AsyncWrite + Unpin,
{
<span class="kw">fn </span>poll_write(
<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;,
ctx: <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="self">self</span>.with_context(ctx, |s| s.write(buf))
}
<span class="kw">fn </span>poll_flush(<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;, ctx: <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="self">self</span>.with_context(ctx, |s| s.flush())
}
<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;, ctx: <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="self">self</span>.with_context(ctx, |s| s.shutdown())
}
}
<span class="attribute">#[cfg(unix)]
</span><span class="kw">impl</span>&lt;S&gt; AsRawFd <span class="kw">for </span>TlsStream&lt;S&gt;
<span class="kw">where
</span>S: AsRawFd,
{
<span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<span class="self">self</span>.get_ref().get_ref().get_ref().as_raw_fd()
}
}
<span class="attribute">#[cfg(windows)]
</span><span class="kw">impl</span>&lt;S&gt; AsRawSocket <span class="kw">for </span>TlsStream&lt;S&gt;
<span class="kw">where
</span>S: AsRawSocket,
{
<span class="kw">fn </span>as_raw_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawSocket {
<span class="self">self</span>.get_ref().get_ref().get_ref().as_raw_socket()
}
}
<span class="kw">async fn </span>handshake&lt;F, S&gt;(f: F, stream: S) -&gt; <span class="prelude-ty">Result</span>&lt;TlsStream&lt;S&gt;, Error&gt;
<span class="kw">where
</span>F: FnOnce(
AllowStd&lt;S&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;native_tls::TlsStream&lt;AllowStd&lt;S&gt;&gt;, HandshakeError&lt;AllowStd&lt;S&gt;&gt;&gt;
+ Unpin,
S: AsyncRead + AsyncWrite + Unpin,
{
<span class="kw">let </span>start = StartedHandshakeFuture(<span class="prelude-val">Some</span>(StartedHandshakeFutureInner { f, stream }));
<span class="kw">match </span>start.<span class="kw">await </span>{
<span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Err</span>(e),
<span class="prelude-val">Ok</span>(StartedHandshake::Done(s)) =&gt; <span class="prelude-val">Ok</span>(s),
<span class="prelude-val">Ok</span>(StartedHandshake::Mid(s)) =&gt; MidHandshake(<span class="prelude-val">Some</span>(s)).<span class="kw">await</span>,
}
}
<span class="kw">impl</span>&lt;F, S&gt; Future <span class="kw">for </span>StartedHandshakeFuture&lt;F, S&gt;
<span class="kw">where
</span>F: FnOnce(
AllowStd&lt;S&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;native_tls::TlsStream&lt;AllowStd&lt;S&gt;&gt;, HandshakeError&lt;AllowStd&lt;S&gt;&gt;&gt;
+ Unpin,
S: Unpin,
AllowStd&lt;S&gt;: Read + Write,
{
<span class="kw">type </span>Output = <span class="prelude-ty">Result</span>&lt;StartedHandshake&lt;S&gt;, Error&gt;;
<span class="kw">fn </span>poll(
<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;,
ctx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;StartedHandshake&lt;S&gt;, Error&gt;&gt; {
<span class="kw">let </span>inner = <span class="self">self</span>.<span class="number">0</span>.take().expect(<span class="string">&quot;future polled after completion&quot;</span>);
<span class="kw">let </span>stream = AllowStd {
inner: inner.stream,
context: ctx <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ as </span><span class="kw-2">*mut </span>(),
};
<span class="kw">match </span>(inner.f)(stream) {
<span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>s) =&gt; {
s.get_mut().context = null_mut();
Poll::Ready(<span class="prelude-val">Ok</span>(StartedHandshake::Done(TlsStream(s))))
}
<span class="prelude-val">Err</span>(HandshakeError::WouldBlock(<span class="kw-2">mut </span>s)) =&gt; {
s.get_mut().context = null_mut();
Poll::Ready(<span class="prelude-val">Ok</span>(StartedHandshake::Mid(s)))
}
<span class="prelude-val">Err</span>(HandshakeError::Failure(e)) =&gt; Poll::Ready(<span class="prelude-val">Err</span>(e)),
}
}
}
<span class="kw">impl </span>TlsConnector {
<span class="doccomment">/// Connects the provided stream with this connector, assuming the provided
/// domain.
///
/// This function will internally call `TlsConnector::connect` to connect
/// the stream and returns a future representing the resolution of the
/// connection operation. The returned future will resolve to either
/// `TlsStream&lt;S&gt;` or `Error` depending if it&#39;s successful or not.
///
/// This is typically used for clients who have already established, for
/// example, a TCP connection to a remote server. That stream is then
/// provided here to perform the client half of a connection to a
/// TLS-powered server.
</span><span class="kw">pub async fn </span>connect&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, domain: <span class="kw-2">&amp;</span>str, stream: S) -&gt; <span class="prelude-ty">Result</span>&lt;TlsStream&lt;S&gt;, Error&gt;
<span class="kw">where
</span>S: AsyncRead + AsyncWrite + Unpin,
{
handshake(<span class="kw">move </span>|s| <span class="self">self</span>.<span class="number">0</span>.connect(domain, s), stream).<span class="kw">await
</span>}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TlsConnector {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;TlsConnector&quot;</span>).finish()
}
}
<span class="kw">impl </span>From&lt;native_tls::TlsConnector&gt; <span class="kw">for </span>TlsConnector {
<span class="kw">fn </span>from(inner: native_tls::TlsConnector) -&gt; TlsConnector {
TlsConnector(inner)
}
}
<span class="kw">impl </span>TlsAcceptor {
<span class="doccomment">/// Accepts a new client connection with the provided stream.
///
/// This function will internally call `TlsAcceptor::accept` to connect
/// the stream and returns a future representing the resolution of the
/// connection operation. The returned future will resolve to either
/// `TlsStream&lt;S&gt;` or `Error` depending if it&#39;s successful or not.
///
/// This is typically used after a new socket has been accepted from a
/// `TcpListener`. That socket is then passed to this function to perform
/// the server half of accepting a client connection.
</span><span class="kw">pub async fn </span>accept&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, stream: S) -&gt; <span class="prelude-ty">Result</span>&lt;TlsStream&lt;S&gt;, Error&gt;
<span class="kw">where
</span>S: AsyncRead + AsyncWrite + Unpin,
{
handshake(<span class="kw">move </span>|s| <span class="self">self</span>.<span class="number">0</span>.accept(s), stream).<span class="kw">await
</span>}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TlsAcceptor {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;TlsAcceptor&quot;</span>).finish()
}
}
<span class="kw">impl </span>From&lt;native_tls::TlsAcceptor&gt; <span class="kw">for </span>TlsAcceptor {
<span class="kw">fn </span>from(inner: native_tls::TlsAcceptor) -&gt; TlsAcceptor {
TlsAcceptor(inner)
}
}
<span class="kw">impl</span>&lt;S: AsyncRead + AsyncWrite + Unpin&gt; Future <span class="kw">for </span>MidHandshake&lt;S&gt; {
<span class="kw">type </span>Output = <span class="prelude-ty">Result</span>&lt;TlsStream&lt;S&gt;, Error&gt;;
<span class="kw">fn </span>poll(<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;<span class="self">Self</span>::Output&gt; {
<span class="kw">let </span>mut_self = <span class="self">self</span>.get_mut();
<span class="kw">let </span><span class="kw-2">mut </span>s = mut_self.<span class="number">0</span>.take().expect(<span class="string">&quot;future polled after completion&quot;</span>);
s.get_mut().context = cx <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ as </span><span class="kw-2">*mut </span>();
<span class="kw">match </span>s.handshake() {
<span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>s) =&gt; {
s.get_mut().context = null_mut();
Poll::Ready(<span class="prelude-val">Ok</span>(TlsStream(s)))
}
<span class="prelude-val">Err</span>(HandshakeError::WouldBlock(<span class="kw-2">mut </span>s)) =&gt; {
s.get_mut().context = null_mut();
mut_self.<span class="number">0 </span>= <span class="prelude-val">Some</span>(s);
Poll::Pending
}
<span class="prelude-val">Err</span>(HandshakeError::Failure(e)) =&gt; Poll::Ready(<span class="prelude-val">Err</span>(e)),
}
}
}
<span class="doccomment">/// re-export native_tls
</span><span class="kw">pub mod </span>native_tls {
<span class="kw">pub use </span>native_tls::<span class="kw-2">*</span>;
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio_native_tls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>