| <!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/settings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>settings.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> |
| <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> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::frame::{util, Error, Frame, FrameSize, Head, Kind, StreamId}; |
| <span class="kw">use </span>bytes::{BufMut, BytesMut}; |
| |
| <span class="attribute">#[derive(Clone, Default, Eq, PartialEq)] |
| </span><span class="kw">pub struct </span>Settings { |
| flags: SettingsFlags, |
| <span class="comment">// Fields |
| </span>header_table_size: <span class="prelude-ty">Option</span><u32>, |
| enable_push: <span class="prelude-ty">Option</span><u32>, |
| max_concurrent_streams: <span class="prelude-ty">Option</span><u32>, |
| initial_window_size: <span class="prelude-ty">Option</span><u32>, |
| max_frame_size: <span class="prelude-ty">Option</span><u32>, |
| max_header_list_size: <span class="prelude-ty">Option</span><u32>, |
| enable_connect_protocol: <span class="prelude-ty">Option</span><u32>, |
| } |
| |
| <span class="doccomment">/// An enum that lists all valid settings that can be sent in a SETTINGS |
| /// frame. |
| /// |
| /// Each setting has a value that is a 32 bit unsigned integer (6.5.1.). |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub enum </span>Setting { |
| HeaderTableSize(u32), |
| EnablePush(u32), |
| MaxConcurrentStreams(u32), |
| InitialWindowSize(u32), |
| MaxFrameSize(u32), |
| MaxHeaderListSize(u32), |
| EnableConnectProtocol(u32), |
| } |
| |
| <span class="attribute">#[derive(Copy, Clone, Eq, PartialEq, Default)] |
| </span><span class="kw">pub struct </span>SettingsFlags(u8); |
| |
| <span class="kw">const </span>ACK: u8 = <span class="number">0x1</span>; |
| <span class="kw">const </span>ALL: u8 = ACK; |
| |
| <span class="doccomment">/// The default value of SETTINGS_HEADER_TABLE_SIZE |
| </span><span class="kw">pub const </span>DEFAULT_SETTINGS_HEADER_TABLE_SIZE: usize = <span class="number">4_096</span>; |
| |
| <span class="doccomment">/// The default value of SETTINGS_INITIAL_WINDOW_SIZE |
| </span><span class="kw">pub const </span>DEFAULT_INITIAL_WINDOW_SIZE: u32 = <span class="number">65_535</span>; |
| |
| <span class="doccomment">/// The default value of MAX_FRAME_SIZE |
| </span><span class="kw">pub const </span>DEFAULT_MAX_FRAME_SIZE: FrameSize = <span class="number">16_384</span>; |
| |
| <span class="doccomment">/// INITIAL_WINDOW_SIZE upper bound |
| </span><span class="kw">pub const </span>MAX_INITIAL_WINDOW_SIZE: usize = (<span class="number">1 </span><< <span class="number">31</span>) - <span class="number">1</span>; |
| |
| <span class="doccomment">/// MAX_FRAME_SIZE upper bound |
| </span><span class="kw">pub const </span>MAX_MAX_FRAME_SIZE: FrameSize = (<span class="number">1 </span><< <span class="number">24</span>) - <span class="number">1</span>; |
| |
| <span class="comment">// ===== impl Settings ===== |
| |
| </span><span class="kw">impl </span>Settings { |
| <span class="kw">pub fn </span>ack() -> Settings { |
| Settings { |
| flags: SettingsFlags::ack(), |
| ..Settings::default() |
| } |
| } |
| |
| <span class="kw">pub fn </span>is_ack(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.flags.is_ack() |
| } |
| |
| <span class="kw">pub fn </span>initial_window_size(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u32> { |
| <span class="self">self</span>.initial_window_size |
| } |
| |
| <span class="kw">pub fn </span>set_initial_window_size(<span class="kw-2">&mut </span><span class="self">self</span>, size: <span class="prelude-ty">Option</span><u32>) { |
| <span class="self">self</span>.initial_window_size = size; |
| } |
| |
| <span class="kw">pub fn </span>max_concurrent_streams(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u32> { |
| <span class="self">self</span>.max_concurrent_streams |
| } |
| |
| <span class="kw">pub fn </span>set_max_concurrent_streams(<span class="kw-2">&mut </span><span class="self">self</span>, max: <span class="prelude-ty">Option</span><u32>) { |
| <span class="self">self</span>.max_concurrent_streams = max; |
| } |
| |
| <span class="kw">pub fn </span>max_frame_size(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u32> { |
| <span class="self">self</span>.max_frame_size |
| } |
| |
| <span class="kw">pub fn </span>set_max_frame_size(<span class="kw-2">&mut </span><span class="self">self</span>, size: <span class="prelude-ty">Option</span><u32>) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(val) = size { |
| <span class="macro">assert!</span>(DEFAULT_MAX_FRAME_SIZE <= val && val <= MAX_MAX_FRAME_SIZE); |
| } |
| <span class="self">self</span>.max_frame_size = size; |
| } |
| |
| <span class="kw">pub fn </span>max_header_list_size(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u32> { |
| <span class="self">self</span>.max_header_list_size |
| } |
| |
| <span class="kw">pub fn </span>set_max_header_list_size(<span class="kw-2">&mut </span><span class="self">self</span>, size: <span class="prelude-ty">Option</span><u32>) { |
| <span class="self">self</span>.max_header_list_size = size; |
| } |
| |
| <span class="kw">pub fn </span>is_push_enabled(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><bool> { |
| <span class="self">self</span>.enable_push.map(|val| val != <span class="number">0</span>) |
| } |
| |
| <span class="kw">pub fn </span>set_enable_push(<span class="kw-2">&mut </span><span class="self">self</span>, enable: bool) { |
| <span class="self">self</span>.enable_push = <span class="prelude-val">Some</span>(enable <span class="kw">as </span>u32); |
| } |
| |
| <span class="kw">pub fn </span>is_extended_connect_protocol_enabled(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><bool> { |
| <span class="self">self</span>.enable_connect_protocol.map(|val| val != <span class="number">0</span>) |
| } |
| |
| <span class="kw">pub fn </span>set_enable_connect_protocol(<span class="kw-2">&mut </span><span class="self">self</span>, val: <span class="prelude-ty">Option</span><u32>) { |
| <span class="self">self</span>.enable_connect_protocol = val; |
| } |
| |
| <span class="kw">pub fn </span>header_table_size(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u32> { |
| <span class="self">self</span>.header_table_size |
| } |
| |
| <span class="comment">/* |
| pub fn set_header_table_size(&mut self, size: Option<u32>) { |
| self.header_table_size = size; |
| } |
| */ |
| |
| </span><span class="kw">pub fn </span>load(head: Head, payload: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><Settings, Error> { |
| <span class="kw">use </span><span class="self">self</span>::Setting::<span class="kw-2">*</span>; |
| |
| <span class="macro">debug_assert_eq!</span>(head.kind(), <span class="kw">crate</span>::frame::Kind::Settings); |
| |
| <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="comment">// Load the flag |
| </span><span class="kw">let </span>flag = SettingsFlags::load(head.flag()); |
| |
| <span class="kw">if </span>flag.is_ack() { |
| <span class="comment">// Ensure that the payload is empty |
| </span><span class="kw">if </span>!payload.is_empty() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPayloadLength); |
| } |
| |
| <span class="comment">// Return the ACK frame |
| </span><span class="kw">return </span><span class="prelude-val">Ok</span>(Settings::ack()); |
| } |
| |
| <span class="comment">// Ensure the payload length is correct, each setting is 6 bytes long. |
| </span><span class="kw">if </span>payload.len() % <span class="number">6 </span>!= <span class="number">0 </span>{ |
| <span class="macro">tracing::debug!</span>(<span class="string">"invalid settings payload length; len={:?}"</span>, payload.len()); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPayloadAckSettings); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>settings = Settings::default(); |
| <span class="macro">debug_assert!</span>(!settings.flags.is_ack()); |
| |
| <span class="kw">for </span>raw <span class="kw">in </span>payload.chunks(<span class="number">6</span>) { |
| <span class="kw">match </span>Setting::load(raw) { |
| <span class="prelude-val">Some</span>(HeaderTableSize(val)) => { |
| settings.header_table_size = <span class="prelude-val">Some</span>(val); |
| } |
| <span class="prelude-val">Some</span>(EnablePush(val)) => <span class="kw">match </span>val { |
| <span class="number">0 </span>| <span class="number">1 </span>=> { |
| settings.enable_push = <span class="prelude-val">Some</span>(val); |
| } |
| <span class="kw">_ </span>=> { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidSettingValue); |
| } |
| }, |
| <span class="prelude-val">Some</span>(MaxConcurrentStreams(val)) => { |
| settings.max_concurrent_streams = <span class="prelude-val">Some</span>(val); |
| } |
| <span class="prelude-val">Some</span>(InitialWindowSize(val)) => { |
| <span class="kw">if </span>val <span class="kw">as </span>usize > MAX_INITIAL_WINDOW_SIZE { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidSettingValue); |
| } <span class="kw">else </span>{ |
| settings.initial_window_size = <span class="prelude-val">Some</span>(val); |
| } |
| } |
| <span class="prelude-val">Some</span>(MaxFrameSize(val)) => { |
| <span class="kw">if </span>DEFAULT_MAX_FRAME_SIZE <= val && val <= MAX_MAX_FRAME_SIZE { |
| settings.max_frame_size = <span class="prelude-val">Some</span>(val); |
| } <span class="kw">else </span>{ |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidSettingValue); |
| } |
| } |
| <span class="prelude-val">Some</span>(MaxHeaderListSize(val)) => { |
| settings.max_header_list_size = <span class="prelude-val">Some</span>(val); |
| } |
| <span class="prelude-val">Some</span>(EnableConnectProtocol(val)) => <span class="kw">match </span>val { |
| <span class="number">0 </span>| <span class="number">1 </span>=> { |
| settings.enable_connect_protocol = <span class="prelude-val">Some</span>(val); |
| } |
| <span class="kw">_ </span>=> { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidSettingValue); |
| } |
| }, |
| <span class="prelude-val">None </span>=> {} |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(settings) |
| } |
| |
| <span class="kw">fn </span>payload_len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>; |
| <span class="self">self</span>.for_each(|<span class="kw">_</span>| len += <span class="number">6</span>); |
| len |
| } |
| |
| <span class="kw">pub fn </span>encode(<span class="kw-2">&</span><span class="self">self</span>, dst: <span class="kw-2">&mut </span>BytesMut) { |
| <span class="comment">// Create & encode an appropriate frame head |
| </span><span class="kw">let </span>head = Head::new(Kind::Settings, <span class="self">self</span>.flags.into(), StreamId::zero()); |
| <span class="kw">let </span>payload_len = <span class="self">self</span>.payload_len(); |
| |
| <span class="macro">tracing::trace!</span>(<span class="string">"encoding SETTINGS; len={}"</span>, payload_len); |
| |
| head.encode(payload_len, dst); |
| |
| <span class="comment">// Encode the settings |
| </span><span class="self">self</span>.for_each(|setting| { |
| <span class="macro">tracing::trace!</span>(<span class="string">"encoding setting; val={:?}"</span>, setting); |
| setting.encode(dst) |
| }); |
| } |
| |
| <span class="kw">fn </span>for_each<F: FnMut(Setting)>(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw-2">mut </span>f: F) { |
| <span class="kw">use </span><span class="self">self</span>::Setting::<span class="kw-2">*</span>; |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.header_table_size { |
| f(HeaderTableSize(v)); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.enable_push { |
| f(EnablePush(v)); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.max_concurrent_streams { |
| f(MaxConcurrentStreams(v)); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.initial_window_size { |
| f(InitialWindowSize(v)); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.max_frame_size { |
| f(MaxFrameSize(v)); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.max_header_list_size { |
| f(MaxHeaderListSize(v)); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="self">self</span>.enable_connect_protocol { |
| f(EnableConnectProtocol(v)); |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> From<Settings> <span class="kw">for </span>Frame<T> { |
| <span class="kw">fn </span>from(src: Settings) -> Frame<T> { |
| Frame::Settings(src) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Settings { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">let </span><span class="kw-2">mut </span>builder = f.debug_struct(<span class="string">"Settings"</span>); |
| builder.field(<span class="string">"flags"</span>, <span class="kw-2">&</span><span class="self">self</span>.flags); |
| |
| <span class="self">self</span>.for_each(|setting| <span class="kw">match </span>setting { |
| Setting::EnablePush(v) => { |
| builder.field(<span class="string">"enable_push"</span>, <span class="kw-2">&</span>v); |
| } |
| Setting::HeaderTableSize(v) => { |
| builder.field(<span class="string">"header_table_size"</span>, <span class="kw-2">&</span>v); |
| } |
| Setting::InitialWindowSize(v) => { |
| builder.field(<span class="string">"initial_window_size"</span>, <span class="kw-2">&</span>v); |
| } |
| Setting::MaxConcurrentStreams(v) => { |
| builder.field(<span class="string">"max_concurrent_streams"</span>, <span class="kw-2">&</span>v); |
| } |
| Setting::MaxFrameSize(v) => { |
| builder.field(<span class="string">"max_frame_size"</span>, <span class="kw-2">&</span>v); |
| } |
| Setting::MaxHeaderListSize(v) => { |
| builder.field(<span class="string">"max_header_list_size"</span>, <span class="kw-2">&</span>v); |
| } |
| Setting::EnableConnectProtocol(v) => { |
| builder.field(<span class="string">"enable_connect_protocol"</span>, <span class="kw-2">&</span>v); |
| } |
| }); |
| |
| builder.finish() |
| } |
| } |
| |
| <span class="comment">// ===== impl Setting ===== |
| |
| </span><span class="kw">impl </span>Setting { |
| <span class="doccomment">/// Creates a new `Setting` with the correct variant corresponding to the |
| /// given setting id, based on the settings IDs defined in section |
| /// 6.5.2. |
| </span><span class="kw">pub fn </span>from_id(id: u16, val: u32) -> <span class="prelude-ty">Option</span><Setting> { |
| <span class="kw">use </span><span class="self">self</span>::Setting::<span class="kw-2">*</span>; |
| |
| <span class="kw">match </span>id { |
| <span class="number">1 </span>=> <span class="prelude-val">Some</span>(HeaderTableSize(val)), |
| <span class="number">2 </span>=> <span class="prelude-val">Some</span>(EnablePush(val)), |
| <span class="number">3 </span>=> <span class="prelude-val">Some</span>(MaxConcurrentStreams(val)), |
| <span class="number">4 </span>=> <span class="prelude-val">Some</span>(InitialWindowSize(val)), |
| <span class="number">5 </span>=> <span class="prelude-val">Some</span>(MaxFrameSize(val)), |
| <span class="number">6 </span>=> <span class="prelude-val">Some</span>(MaxHeaderListSize(val)), |
| <span class="number">8 </span>=> <span class="prelude-val">Some</span>(EnableConnectProtocol(val)), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Creates a new `Setting` by parsing the given buffer of 6 bytes, which |
| /// contains the raw byte representation of the setting, according to the |
| /// "SETTINGS format" defined in section 6.5.1. |
| /// |
| /// The `raw` parameter should have length at least 6 bytes, since the |
| /// length of the raw setting is exactly 6 bytes. |
| /// |
| /// # Panics |
| /// |
| /// If given a buffer shorter than 6 bytes, the function will panic. |
| </span><span class="kw">fn </span>load(raw: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><Setting> { |
| <span class="kw">let </span>id: u16 = (u16::from(raw[<span class="number">0</span>]) << <span class="number">8</span>) | u16::from(raw[<span class="number">1</span>]); |
| <span class="kw">let </span>val: u32 = <span class="macro">unpack_octets_4!</span>(raw, <span class="number">2</span>, u32); |
| |
| Setting::from_id(id, val) |
| } |
| |
| <span class="kw">fn </span>encode(<span class="kw-2">&</span><span class="self">self</span>, dst: <span class="kw-2">&mut </span>BytesMut) { |
| <span class="kw">use </span><span class="self">self</span>::Setting::<span class="kw-2">*</span>; |
| |
| <span class="kw">let </span>(kind, val) = <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| HeaderTableSize(v) => (<span class="number">1</span>, v), |
| EnablePush(v) => (<span class="number">2</span>, v), |
| MaxConcurrentStreams(v) => (<span class="number">3</span>, v), |
| InitialWindowSize(v) => (<span class="number">4</span>, v), |
| MaxFrameSize(v) => (<span class="number">5</span>, v), |
| MaxHeaderListSize(v) => (<span class="number">6</span>, v), |
| EnableConnectProtocol(v) => (<span class="number">8</span>, v), |
| }; |
| |
| dst.put_u16(kind); |
| dst.put_u32(val); |
| } |
| } |
| |
| <span class="comment">// ===== impl SettingsFlags ===== |
| |
| </span><span class="kw">impl </span>SettingsFlags { |
| <span class="kw">pub fn </span>empty() -> SettingsFlags { |
| SettingsFlags(<span class="number">0</span>) |
| } |
| |
| <span class="kw">pub fn </span>load(bits: u8) -> SettingsFlags { |
| SettingsFlags(bits & ALL) |
| } |
| |
| <span class="kw">pub fn </span>ack() -> SettingsFlags { |
| SettingsFlags(ACK) |
| } |
| |
| <span class="kw">pub fn </span>is_ack(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.<span class="number">0 </span>& ACK == ACK |
| } |
| } |
| |
| <span class="kw">impl </span>From<SettingsFlags> <span class="kw">for </span>u8 { |
| <span class="kw">fn </span>from(src: SettingsFlags) -> u8 { |
| src.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>SettingsFlags { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| util::debug_flags(f, <span class="self">self</span>.<span class="number">0</span>) |
| .flag_if(<span class="self">self</span>.is_ack(), <span class="string">"ACK"</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> |
