| <!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/rustls-0.19.1/src/stream.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stream.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="../../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="../../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> |
| <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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::session::Session; |
| <span class="kw">use </span>std::io::{IoSlice, Read, <span class="prelude-ty">Result</span>, Write}; |
| |
| <span class="doccomment">/// This type implements `io::Read` and `io::Write`, encapsulating |
| /// a Session `S` and an underlying transport `T`, such as a socket. |
| /// |
| /// This allows you to use a rustls Session like a normal stream. |
| </span><span class="kw">pub struct </span>Stream<<span class="lifetime">'a</span>, S: <span class="lifetime">'a </span>+ Session + <span class="question-mark">?</span>Sized, T: <span class="lifetime">'a </span>+ Read + Write + <span class="question-mark">?</span>Sized> { |
| <span class="doccomment">/// Our session |
| </span><span class="kw">pub </span>sess: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>S, |
| |
| <span class="doccomment">/// The underlying transport, like a socket |
| </span><span class="kw">pub </span>sock: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>T, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, S, T> Stream<<span class="lifetime">'a</span>, S, T> |
| <span class="kw">where |
| </span>S: <span class="lifetime">'a </span>+ Session, |
| T: <span class="lifetime">'a </span>+ Read + Write, |
| { |
| <span class="doccomment">/// Make a new Stream using the Session `sess` and socket-like object |
| /// `sock`. This does not fail and does no IO. |
| </span><span class="kw">pub fn </span>new(sess: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>S, sock: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>T) -> Stream<<span class="lifetime">'a</span>, S, T> { |
| Stream { sess, sock } |
| } |
| |
| <span class="doccomment">/// If we're handshaking, complete all the IO for that. |
| /// If we have data to write, write it all. |
| </span><span class="kw">fn </span>complete_prior_io(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><()> { |
| <span class="kw">if </span><span class="self">self</span>.sess.is_handshaking() { |
| <span class="self">self</span>.sess.complete_io(<span class="self">self</span>.sock)<span class="question-mark">?</span>; |
| } |
| |
| <span class="kw">if </span><span class="self">self</span>.sess.wants_write() { |
| <span class="self">self</span>.sess.complete_io(<span class="self">self</span>.sock)<span class="question-mark">?</span>; |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, S, T> Read <span class="kw">for </span>Stream<<span class="lifetime">'a</span>, S, T> |
| <span class="kw">where |
| </span>S: <span class="lifetime">'a </span>+ Session, |
| T: <span class="lifetime">'a </span>+ Read + Write, |
| { |
| <span class="kw">fn </span>read(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><usize> { |
| <span class="self">self</span>.complete_prior_io()<span class="question-mark">?</span>; |
| |
| <span class="comment">// We call complete_io() in a loop since a single call may read only |
| // a partial packet from the underlying transport. A full packet is |
| // needed to get more plaintext, which we must do if EOF has not been |
| // hit. Otherwise, we will prematurely signal EOF by returning 0. We |
| // determine if EOF has actually been hit by checking if 0 bytes were |
| // read from the underlying transport. |
| </span><span class="kw">while </span><span class="self">self</span>.sess.wants_read() && <span class="self">self</span>.sess.complete_io(<span class="self">self</span>.sock)<span class="question-mark">?</span>.<span class="number">0 </span>!= <span class="number">0 </span>{} |
| |
| <span class="self">self</span>.sess.read(buf) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, S, T> Write <span class="kw">for </span>Stream<<span class="lifetime">'a</span>, S, T> |
| <span class="kw">where |
| </span>S: <span class="lifetime">'a </span>+ Session, |
| T: <span class="lifetime">'a </span>+ Read + Write, |
| { |
| <span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><usize> { |
| <span class="self">self</span>.complete_prior_io()<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>len = <span class="self">self</span>.sess.write(buf)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to write the underlying transport here, but don't let |
| // any errors mask the fact we've consumed `len` bytes. |
| // Callers will learn of permanent errors on the next call. |
| </span><span class="kw">let _ </span>= <span class="self">self</span>.sess.complete_io(<span class="self">self</span>.sock); |
| |
| <span class="prelude-val">Ok</span>(len) |
| } |
| |
| <span class="kw">fn </span>write_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&</span>[IoSlice<<span class="lifetime">'_</span>>]) -> <span class="prelude-ty">Result</span><usize> { |
| <span class="self">self</span>.complete_prior_io()<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>len = <span class="self">self</span>.sess.write_vectored(bufs)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to write the underlying transport here, but don't let |
| // any errors mask the fact we've consumed `len` bytes. |
| // Callers will learn of permanent errors on the next call. |
| </span><span class="kw">let _ </span>= <span class="self">self</span>.sess.complete_io(<span class="self">self</span>.sock); |
| |
| <span class="prelude-val">Ok</span>(len) |
| } |
| |
| <span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><()> { |
| <span class="self">self</span>.complete_prior_io()<span class="question-mark">?</span>; |
| |
| <span class="self">self</span>.sess.flush()<span class="question-mark">?</span>; |
| <span class="kw">if </span><span class="self">self</span>.sess.wants_write() { |
| <span class="self">self</span>.sess.complete_io(<span class="self">self</span>.sock)<span class="question-mark">?</span>; |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="doccomment">/// This type implements `io::Read` and `io::Write`, encapsulating |
| /// and owning a Session `S` and an underlying blocking transport |
| /// `T`, such as a socket. |
| /// |
| /// This allows you to use a rustls Session like a normal stream. |
| </span><span class="kw">pub struct </span>StreamOwned<S: Session + Sized, T: Read + Write + Sized> { |
| <span class="doccomment">/// Our session |
| </span><span class="kw">pub </span>sess: S, |
| |
| <span class="doccomment">/// The underlying transport, like a socket |
| </span><span class="kw">pub </span>sock: T, |
| } |
| |
| <span class="kw">impl</span><S, T> StreamOwned<S, T> |
| <span class="kw">where |
| </span>S: Session, |
| T: Read + Write, |
| { |
| <span class="doccomment">/// Make a new StreamOwned taking the Session `sess` and socket-like |
| /// object `sock`. This does not fail and does no IO. |
| /// |
| /// This is the same as `Stream::new` except `sess` and `sock` are |
| /// moved into the StreamOwned. |
| </span><span class="kw">pub fn </span>new(sess: S, sock: T) -> StreamOwned<S, T> { |
| StreamOwned { sess, sock } |
| } |
| |
| <span class="doccomment">/// Get a reference to the underlying socket |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>.sock |
| } |
| |
| <span class="doccomment">/// Get a mutable reference to the underlying socket |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>.sock |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, S, T> StreamOwned<S, T> |
| <span class="kw">where |
| </span>S: Session, |
| T: Read + Write, |
| { |
| <span class="kw">fn </span>as_stream(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>) -> Stream<<span class="lifetime">'a</span>, S, T> { |
| Stream { |
| sess: <span class="kw-2">&mut </span><span class="self">self</span>.sess, |
| sock: <span class="kw-2">&mut </span><span class="self">self</span>.sock, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><S, T> Read <span class="kw">for </span>StreamOwned<S, T> |
| <span class="kw">where |
| </span>S: Session, |
| T: Read + Write, |
| { |
| <span class="kw">fn </span>read(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><usize> { |
| <span class="self">self</span>.as_stream().read(buf) |
| } |
| } |
| |
| <span class="kw">impl</span><S, T> Write <span class="kw">for </span>StreamOwned<S, T> |
| <span class="kw">where |
| </span>S: Session, |
| T: Read + Write, |
| { |
| <span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><usize> { |
| <span class="self">self</span>.as_stream().write(buf) |
| } |
| |
| <span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><()> { |
| <span class="self">self</span>.as_stream().flush() |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::{Stream, StreamOwned}; |
| <span class="kw">use </span><span class="kw">crate</span>::client::ClientSession; |
| <span class="kw">use </span><span class="kw">crate</span>::server::ServerSession; |
| <span class="kw">use </span><span class="kw">crate</span>::session::Session; |
| <span class="kw">use </span>std::net::TcpStream; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>stream_can_be_created_for_session_and_tcpstream() { |
| <span class="kw">type </span>_Test<<span class="lifetime">'a</span>> = Stream<<span class="lifetime">'a</span>, <span class="kw">dyn </span>Session, TcpStream>; |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>streamowned_can_be_created_for_client_and_tcpstream() { |
| <span class="kw">type </span>_Test = StreamOwned<ClientSession, TcpStream>; |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>streamowned_can_be_created_for_server_and_tcpstream() { |
| <span class="kw">type </span>_Test = StreamOwned<ServerSession, TcpStream>; |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
