| <!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/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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::hpack; |
| |
| <span class="kw">use </span>bytes::Bytes; |
| |
| <span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// A helper macro that unpacks a sequence of 4 bytes found in the buffer with |
| /// the given identifier, starting at the given offset, into the given integer |
| /// type. Obviously, the integer type should be able to support at least 4 |
| /// bytes. |
| /// |
| /// # Examples |
| /// |
| /// ```ignore |
| /// # // We ignore this doctest because the macro is not exported. |
| /// let buf: [u8; 4] = [0, 0, 0, 1]; |
| /// assert_eq!(1u32, unpack_octets_4!(buf, 0, u32)); |
| /// ``` |
| </span><span class="macro">macro_rules! </span>unpack_octets_4 { |
| <span class="comment">// TODO: Get rid of this macro |
| </span>(<span class="macro-nonterminal">$buf</span>:expr, <span class="macro-nonterminal">$offset</span>:expr, <span class="macro-nonterminal">$tip</span>:ty) => { |
| ((<span class="macro-nonterminal">$buf</span>[<span class="macro-nonterminal">$offset </span>+ <span class="number">0</span>] <span class="kw">as </span><span class="macro-nonterminal">$tip</span>) << <span class="number">24</span>) |
| | ((<span class="macro-nonterminal">$buf</span>[<span class="macro-nonterminal">$offset </span>+ <span class="number">1</span>] <span class="kw">as </span><span class="macro-nonterminal">$tip</span>) << <span class="number">16</span>) |
| | ((<span class="macro-nonterminal">$buf</span>[<span class="macro-nonterminal">$offset </span>+ <span class="number">2</span>] <span class="kw">as </span><span class="macro-nonterminal">$tip</span>) << <span class="number">8</span>) |
| | ((<span class="macro-nonterminal">$buf</span>[<span class="macro-nonterminal">$offset </span>+ <span class="number">3</span>] <span class="kw">as </span><span class="macro-nonterminal">$tip</span>) << <span class="number">0</span>) |
| }; |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_unpack_octets_4() { |
| <span class="kw">let </span>buf: [u8; <span class="number">4</span>] = [<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>]; |
| <span class="macro">assert_eq!</span>(<span class="number">1u32</span>, <span class="macro">unpack_octets_4!</span>(buf, <span class="number">0</span>, u32)); |
| } |
| } |
| |
| <span class="kw">mod </span>data; |
| <span class="kw">mod </span>go_away; |
| <span class="kw">mod </span>head; |
| <span class="kw">mod </span>headers; |
| <span class="kw">mod </span>ping; |
| <span class="kw">mod </span>priority; |
| <span class="kw">mod </span>reason; |
| <span class="kw">mod </span>reset; |
| <span class="kw">mod </span>settings; |
| <span class="kw">mod </span>stream_id; |
| <span class="kw">mod </span>util; |
| <span class="kw">mod </span>window_update; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::data::Data; |
| <span class="kw">pub use </span><span class="self">self</span>::go_away::GoAway; |
| <span class="kw">pub use </span><span class="self">self</span>::head::{Head, Kind}; |
| <span class="kw">pub use </span><span class="self">self</span>::headers::{ |
| parse_u64, Continuation, Headers, Pseudo, PushPromise, PushPromiseHeaderError, |
| }; |
| <span class="kw">pub use </span><span class="self">self</span>::ping::Ping; |
| <span class="kw">pub use </span><span class="self">self</span>::priority::{Priority, StreamDependency}; |
| <span class="kw">pub use </span><span class="self">self</span>::reason::Reason; |
| <span class="kw">pub use </span><span class="self">self</span>::reset::Reset; |
| <span class="kw">pub use </span><span class="self">self</span>::settings::Settings; |
| <span class="kw">pub use </span><span class="self">self</span>::stream_id::{StreamId, StreamIdOverflow}; |
| <span class="kw">pub use </span><span class="self">self</span>::window_update::WindowUpdate; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::hpack::BytesStr; |
| |
| <span class="comment">// Re-export some constants |
| |
| </span><span class="kw">pub use </span><span class="self">self</span>::settings::{ |
| DEFAULT_INITIAL_WINDOW_SIZE, DEFAULT_MAX_FRAME_SIZE, DEFAULT_SETTINGS_HEADER_TABLE_SIZE, |
| MAX_INITIAL_WINDOW_SIZE, MAX_MAX_FRAME_SIZE, |
| }; |
| |
| <span class="kw">pub type </span>FrameSize = u32; |
| |
| <span class="kw">pub const </span>HEADER_LEN: usize = <span class="number">9</span>; |
| |
| <span class="attribute">#[derive(Eq, PartialEq)] |
| </span><span class="kw">pub enum </span>Frame<T = Bytes> { |
| Data(Data<T>), |
| Headers(Headers), |
| Priority(Priority), |
| PushPromise(PushPromise), |
| Settings(Settings), |
| Ping(Ping), |
| GoAway(GoAway), |
| WindowUpdate(WindowUpdate), |
| Reset(Reset), |
| } |
| |
| <span class="kw">impl</span><T> Frame<T> { |
| <span class="kw">pub fn </span>map<F, U>(<span class="self">self</span>, f: F) -> Frame<U> |
| <span class="kw">where |
| </span>F: FnOnce(T) -> U, |
| { |
| <span class="kw">use </span><span class="self">self</span>::Frame::<span class="kw-2">*</span>; |
| |
| <span class="kw">match </span><span class="self">self </span>{ |
| Data(frame) => frame.map(f).into(), |
| Headers(frame) => frame.into(), |
| Priority(frame) => frame.into(), |
| PushPromise(frame) => frame.into(), |
| Settings(frame) => frame.into(), |
| Ping(frame) => frame.into(), |
| GoAway(frame) => frame.into(), |
| WindowUpdate(frame) => frame.into(), |
| Reset(frame) => frame.into(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>Frame<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">use </span><span class="self">self</span>::Frame::<span class="kw-2">*</span>; |
| |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Data(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| Headers(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| Priority(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| PushPromise(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| Settings(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| Ping(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| GoAway(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| WindowUpdate(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| Reset(<span class="kw-2">ref </span>frame) => fmt::Debug::fmt(frame, fmt), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Errors that can occur during parsing an HTTP/2 frame. |
| </span><span class="attribute">#[derive(Debug, Clone, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>Error { |
| <span class="doccomment">/// A length value other than 8 was set on a PING message. |
| </span>BadFrameSize, |
| |
| <span class="doccomment">/// The padding length was larger than the frame-header-specified |
| /// length of the payload. |
| </span>TooMuchPadding, |
| |
| <span class="doccomment">/// An invalid setting value was provided |
| </span>InvalidSettingValue, |
| |
| <span class="doccomment">/// An invalid window update value |
| </span>InvalidWindowUpdateValue, |
| |
| <span class="doccomment">/// The payload length specified by the frame header was not the |
| /// value necessary for the specific frame type. |
| </span>InvalidPayloadLength, |
| |
| <span class="doccomment">/// Received a payload with an ACK settings frame |
| </span>InvalidPayloadAckSettings, |
| |
| <span class="doccomment">/// An invalid stream identifier was provided. |
| /// |
| /// This is returned if a SETTINGS or PING frame is received with a stream |
| /// identifier other than zero. |
| </span>InvalidStreamId, |
| |
| <span class="doccomment">/// A request or response is malformed. |
| </span>MalformedMessage, |
| |
| <span class="doccomment">/// An invalid stream dependency ID was provided |
| /// |
| /// This is returned if a HEADERS or PRIORITY frame is received with an |
| /// invalid stream identifier. |
| </span>InvalidDependencyId, |
| |
| <span class="doccomment">/// Failed to perform HPACK decoding |
| </span>Hpack(hpack::DecoderError), |
| } |
| </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> |
