| <!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/frame/data.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>data.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> |
| <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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::frame::{util, Error, Frame, Head, Kind, StreamId}; |
| <span class="kw">use </span>bytes::{Buf, BufMut, Bytes}; |
| |
| <span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// Data frame |
| /// |
| /// Data frames convey arbitrary, variable-length sequences of octets associated |
| /// with a stream. One or more DATA frames are used, for instance, to carry HTTP |
| /// request or response payloads. |
| </span><span class="attribute">#[derive(Eq, PartialEq)] |
| </span><span class="kw">pub struct </span>Data<T = Bytes> { |
| stream_id: StreamId, |
| data: T, |
| flags: DataFlags, |
| pad_len: <span class="prelude-ty">Option</span><u8>, |
| } |
| |
| <span class="attribute">#[derive(Copy, Clone, Default, Eq, PartialEq)] |
| </span><span class="kw">struct </span>DataFlags(u8); |
| |
| <span class="kw">const </span>END_STREAM: u8 = <span class="number">0x1</span>; |
| <span class="kw">const </span>PADDED: u8 = <span class="number">0x8</span>; |
| <span class="kw">const </span>ALL: u8 = END_STREAM | PADDED; |
| |
| <span class="kw">impl</span><T> Data<T> { |
| <span class="doccomment">/// Creates a new DATA frame. |
| </span><span class="kw">pub fn </span>new(stream_id: StreamId, payload: T) -> <span class="self">Self </span>{ |
| <span class="macro">assert!</span>(!stream_id.is_zero()); |
| |
| Data { |
| stream_id, |
| data: payload, |
| flags: DataFlags::default(), |
| pad_len: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the stream identifier that this frame is associated with. |
| /// |
| /// This cannot be a zero stream identifier. |
| </span><span class="kw">pub fn </span>stream_id(<span class="kw-2">&</span><span class="self">self</span>) -> StreamId { |
| <span class="self">self</span>.stream_id |
| } |
| |
| <span class="doccomment">/// Gets the value of the `END_STREAM` flag for this frame. |
| /// |
| /// If true, this frame is the last that the endpoint will send for the |
| /// identified stream. |
| /// |
| /// Setting this flag causes the stream to enter one of the "half-closed" |
| /// states or the "closed" state (Section 5.1). |
| </span><span class="kw">pub fn </span>is_end_stream(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.flags.is_end_stream() |
| } |
| |
| <span class="doccomment">/// Sets the value for the `END_STREAM` flag on this frame. |
| </span><span class="kw">pub fn </span>set_end_stream(<span class="kw-2">&mut </span><span class="self">self</span>, val: bool) { |
| <span class="kw">if </span>val { |
| <span class="self">self</span>.flags.set_end_stream(); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.flags.unset_end_stream(); |
| } |
| } |
| |
| <span class="doccomment">/// Returns whether the `PADDED` flag is set on this frame. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">pub fn </span>is_padded(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.flags.is_padded() |
| } |
| |
| <span class="doccomment">/// Sets the value for the `PADDED` flag on this frame. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">pub fn </span>set_padded(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.flags.set_padded(); |
| } |
| |
| <span class="doccomment">/// Returns a reference to this frame's payload. |
| /// |
| /// This does **not** include any padding that might have been originally |
| /// included. |
| </span><span class="kw">pub fn </span>payload(<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>.data |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to this frame's payload. |
| /// |
| /// This does **not** include any padding that might have been originally |
| /// included. |
| </span><span class="kw">pub fn </span>payload_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>.data |
| } |
| |
| <span class="doccomment">/// Consumes `self` and returns the frame's payload. |
| /// |
| /// This does **not** include any padding that might have been originally |
| /// included. |
| </span><span class="kw">pub fn </span>into_payload(<span class="self">self</span>) -> T { |
| <span class="self">self</span>.data |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>head(<span class="kw-2">&</span><span class="self">self</span>) -> Head { |
| Head::new(Kind::Data, <span class="self">self</span>.flags.into(), <span class="self">self</span>.stream_id) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>map<F, U>(<span class="self">self</span>, f: F) -> Data<U> |
| <span class="kw">where |
| </span>F: FnOnce(T) -> U, |
| { |
| Data { |
| stream_id: <span class="self">self</span>.stream_id, |
| data: f(<span class="self">self</span>.data), |
| flags: <span class="self">self</span>.flags, |
| pad_len: <span class="self">self</span>.pad_len, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Data<Bytes> { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>load(head: Head, <span class="kw-2">mut </span>payload: Bytes) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, Error> { |
| <span class="kw">let </span>flags = DataFlags::load(head.flag()); |
| |
| <span class="comment">// The stream identifier must not be zero |
| </span><span class="kw">if </span>head.stream_id().is_zero() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidStreamId); |
| } |
| |
| <span class="kw">let </span>pad_len = <span class="kw">if </span>flags.is_padded() { |
| <span class="kw">let </span>len = util::strip_padding(<span class="kw-2">&mut </span>payload)<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(len) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>}; |
| |
| <span class="prelude-val">Ok</span>(Data { |
| stream_id: head.stream_id(), |
| data: payload, |
| flags, |
| pad_len, |
| }) |
| } |
| } |
| |
| <span class="kw">impl</span><T: Buf> Data<T> { |
| <span class="doccomment">/// Encode the data frame into the `dst` buffer. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `dst` cannot contain the data frame. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_chunk<U: BufMut>(<span class="kw-2">&mut </span><span class="self">self</span>, dst: <span class="kw-2">&mut </span>U) { |
| <span class="kw">let </span>len = <span class="self">self</span>.data.remaining() <span class="kw">as </span>usize; |
| |
| <span class="macro">assert!</span>(dst.remaining_mut() >= len); |
| |
| <span class="self">self</span>.head().encode(len, dst); |
| dst.put(<span class="kw-2">&mut </span><span class="self">self</span>.data); |
| } |
| } |
| |
| <span class="kw">impl</span><T> From<Data<T>> <span class="kw">for </span>Frame<T> { |
| <span class="kw">fn </span>from(src: Data<T>) -> <span class="self">Self </span>{ |
| Frame::Data(src) |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>Data<T> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">let </span><span class="kw-2">mut </span>f = fmt.debug_struct(<span class="string">"Data"</span>); |
| f.field(<span class="string">"stream_id"</span>, <span class="kw-2">&</span><span class="self">self</span>.stream_id); |
| <span class="kw">if </span>!<span class="self">self</span>.flags.is_empty() { |
| f.field(<span class="string">"flags"</span>, <span class="kw-2">&</span><span class="self">self</span>.flags); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>pad_len) = <span class="self">self</span>.pad_len { |
| f.field(<span class="string">"pad_len"</span>, pad_len); |
| } |
| <span class="comment">// `data` bytes purposefully excluded |
| </span>f.finish() |
| } |
| } |
| |
| <span class="comment">// ===== impl DataFlags ===== |
| |
| </span><span class="kw">impl </span>DataFlags { |
| <span class="kw">fn </span>load(bits: u8) -> DataFlags { |
| DataFlags(bits & ALL) |
| } |
| |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.<span class="number">0 </span>== <span class="number">0 |
| </span>} |
| |
| <span class="kw">fn </span>is_end_stream(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.<span class="number">0 </span>& END_STREAM == END_STREAM |
| } |
| |
| <span class="kw">fn </span>set_end_stream(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0 </span>|= END_STREAM |
| } |
| |
| <span class="kw">fn </span>unset_end_stream(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0 </span>&= !END_STREAM |
| } |
| |
| <span class="kw">fn </span>is_padded(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.<span class="number">0 </span>& PADDED == PADDED |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">fn </span>set_padded(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0 </span>|= PADDED |
| } |
| } |
| |
| <span class="kw">impl </span>From<DataFlags> <span class="kw">for </span>u8 { |
| <span class="kw">fn </span>from(src: DataFlags) -> u8 { |
| src.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DataFlags { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| util::debug_flags(fmt, <span class="self">self</span>.<span class="number">0</span>) |
| .flag_if(<span class="self">self</span>.is_end_stream(), <span class="string">"END_STREAM"</span>) |
| .flag_if(<span class="self">self</span>.is_padded(), <span class="string">"PADDED"</span>) |
| .finish() |
| } |
| } |
| </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> |
