| <!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/h2-0.3.19/src/codec/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="../../../h2/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="../../../h2/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">mod </span>error; |
| <span class="kw">mod </span>framed_read; |
| <span class="kw">mod </span>framed_write; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::error::{SendError, UserError}; |
| |
| <span class="kw">use </span><span class="self">self</span>::framed_read::FramedRead; |
| <span class="kw">use </span><span class="self">self</span>::framed_write::FramedWrite; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::frame::{<span class="self">self</span>, Data, Frame}; |
| <span class="kw">use </span><span class="kw">crate</span>::proto::Error; |
| |
| <span class="kw">use </span>bytes::Buf; |
| <span class="kw">use </span>futures_core::Stream; |
| <span class="kw">use </span>futures_sink::Sink; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| <span class="kw">use </span>tokio::io::{AsyncRead, AsyncWrite}; |
| <span class="kw">use </span>tokio_util::codec::length_delimited; |
| |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Codec<T, B> { |
| inner: FramedRead<FramedWrite<T, B>>, |
| } |
| |
| <span class="kw">impl</span><T, B> Codec<T, B> |
| <span class="kw">where |
| </span>T: AsyncRead + AsyncWrite + Unpin, |
| B: Buf, |
| { |
| <span class="doccomment">/// Returns a new `Codec` with the default max frame size |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new(io: T) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::with_max_recv_frame_size(io, frame::DEFAULT_MAX_FRAME_SIZE <span class="kw">as </span>usize) |
| } |
| |
| <span class="doccomment">/// Returns a new `Codec` with the given maximum frame size |
| </span><span class="kw">pub fn </span>with_max_recv_frame_size(io: T, max_frame_size: usize) -> <span class="self">Self </span>{ |
| <span class="comment">// Wrap with writer |
| </span><span class="kw">let </span>framed_write = FramedWrite::new(io); |
| |
| <span class="comment">// Delimit the frames |
| </span><span class="kw">let </span>delimited = length_delimited::Builder::new() |
| .big_endian() |
| .length_field_length(<span class="number">3</span>) |
| .length_adjustment(<span class="number">9</span>) |
| .num_skip(<span class="number">0</span>) <span class="comment">// Don't skip the header |
| </span>.new_read(framed_write); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = FramedRead::new(delimited); |
| |
| <span class="comment">// Use FramedRead's method since it checks the value is within range. |
| </span>inner.set_max_frame_size(max_frame_size); |
| |
| Codec { inner } |
| } |
| } |
| |
| <span class="kw">impl</span><T, B> Codec<T, B> { |
| <span class="doccomment">/// Updates the max received frame size. |
| /// |
| /// The change takes effect the next time a frame is decoded. In other |
| /// words, if a frame is currently in process of being decoded with a frame |
| /// size greater than `val` but less than the max frame size in effect |
| /// before calling this function, then the frame will be allowed. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_max_recv_frame_size(<span class="kw-2">&mut </span><span class="self">self</span>, val: usize) { |
| <span class="self">self</span>.inner.set_max_frame_size(val) |
| } |
| |
| <span class="doccomment">/// Returns the current max received frame size setting. |
| /// |
| /// This is the largest size this codec will accept from the wire. Larger |
| /// frames will be rejected. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| #[inline] |
| </span><span class="kw">pub fn </span>max_recv_frame_size(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.inner.max_frame_size() |
| } |
| |
| <span class="doccomment">/// Returns the max frame size that can be sent to the peer. |
| </span><span class="kw">pub fn </span>max_send_frame_size(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.inner.get_ref().max_frame_size() |
| } |
| |
| <span class="doccomment">/// Set the peer's max frame size. |
| </span><span class="kw">pub fn </span>set_max_send_frame_size(<span class="kw-2">&mut </span><span class="self">self</span>, val: usize) { |
| <span class="self">self</span>.framed_write().set_max_frame_size(val) |
| } |
| |
| <span class="doccomment">/// Set the peer's header table size size. |
| </span><span class="kw">pub fn </span>set_send_header_table_size(<span class="kw-2">&mut </span><span class="self">self</span>, val: usize) { |
| <span class="self">self</span>.framed_write().set_header_table_size(val) |
| } |
| |
| <span class="doccomment">/// Set the max header list size that can be received. |
| </span><span class="kw">pub fn </span>set_max_recv_header_list_size(<span class="kw-2">&mut </span><span class="self">self</span>, val: usize) { |
| <span class="self">self</span>.inner.set_max_header_list_size(val); |
| } |
| |
| <span class="doccomment">/// Get a reference to the inner stream. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </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="self">self</span>.inner.get_ref().get_ref() |
| } |
| |
| <span class="doccomment">/// Get a mutable reference to the inner stream. |
| </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="self">self</span>.inner.get_mut().get_mut() |
| } |
| |
| <span class="doccomment">/// Takes the data payload value that was fully written to the socket |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>take_last_data_frame(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Data<B>> { |
| <span class="self">self</span>.framed_write().take_last_data_frame() |
| } |
| |
| <span class="kw">fn </span>framed_write(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>FramedWrite<T, B> { |
| <span class="self">self</span>.inner.get_mut() |
| } |
| } |
| |
| <span class="kw">impl</span><T, B> Codec<T, B> |
| <span class="kw">where |
| </span>T: AsyncWrite + Unpin, |
| B: Buf, |
| { |
| <span class="doccomment">/// Returns `Ready` when the codec can buffer a frame |
| </span><span class="kw">pub fn </span>poll_ready(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.framed_write().poll_ready(cx) |
| } |
| |
| <span class="doccomment">/// Buffer a frame. |
| /// |
| /// `poll_ready` must be called first to ensure that a frame may be |
| /// accepted. |
| /// |
| /// TODO: Rename this to avoid conflicts with Sink::buffer |
| </span><span class="kw">pub fn </span>buffer(<span class="kw-2">&mut </span><span class="self">self</span>, item: Frame<B>) -> <span class="prelude-ty">Result</span><(), UserError> { |
| <span class="self">self</span>.framed_write().buffer(item) |
| } |
| |
| <span class="doccomment">/// Flush buffered data to the wire |
| </span><span class="kw">pub fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.framed_write().flush(cx) |
| } |
| |
| <span class="doccomment">/// Shutdown the send half |
| </span><span class="kw">pub fn </span>shutdown(<span class="kw-2">&mut </span><span class="self">self</span>, cx: <span class="kw-2">&mut </span>Context) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.framed_write().shutdown(cx) |
| } |
| } |
| |
| <span class="kw">impl</span><T, B> Stream <span class="kw">for </span>Codec<T, B> |
| <span class="kw">where |
| </span>T: AsyncRead + Unpin, |
| { |
| <span class="kw">type </span>Item = <span class="prelude-ty">Result</span><Frame, Error>; |
| |
| <span class="kw">fn </span>poll_next(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Option</span><<span class="self">Self</span>::Item>> { |
| Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.inner).poll_next(cx) |
| } |
| } |
| |
| <span class="kw">impl</span><T, B> Sink<Frame<B>> <span class="kw">for </span>Codec<T, B> |
| <span class="kw">where |
| </span>T: AsyncWrite + Unpin, |
| B: Buf, |
| { |
| <span class="kw">type </span>Error = SendError; |
| |
| <span class="kw">fn </span>start_send(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, item: Frame<B>) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error> { |
| Codec::buffer(<span class="kw-2">&mut </span><span class="self">self</span>, item)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| <span class="doccomment">/// Returns `Ready` when the codec can buffer a frame |
| </span><span class="kw">fn </span>poll_ready(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { |
| <span class="self">self</span>.framed_write().poll_ready(cx).map_err(Into::into) |
| } |
| |
| <span class="doccomment">/// Flush buffered data to the wire |
| </span><span class="kw">fn </span>poll_flush(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { |
| <span class="self">self</span>.framed_write().flush(cx).map_err(Into::into) |
| } |
| |
| <span class="kw">fn </span>poll_close(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { |
| <span class="macro">ready!</span>(<span class="self">self</span>.shutdown(cx))<span class="question-mark">?</span>; |
| Poll::Ready(<span class="prelude-val">Ok</span>(())) |
| } |
| } |
| |
| <span class="comment">// TODO: remove (or improve) this |
| </span><span class="kw">impl</span><T> From<T> <span class="kw">for </span>Codec<T, bytes::Bytes> |
| <span class="kw">where |
| </span>T: AsyncRead + AsyncWrite + Unpin, |
| { |
| <span class="kw">fn </span>from(src: T) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new(src) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="h2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |