| <!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/hyper-0.14.26/src/ext.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ext.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="../../hyper/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="../../hyper/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> |
| </pre><pre class="rust"><code><span class="doccomment">//! HTTP extensions. |
| |
| </span><span class="kw">use </span>bytes::Bytes; |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"ffi"</span>))] |
| </span><span class="kw">use </span>http::header::HeaderName; |
| <span class="attribute">#[cfg(feature = <span class="string">"http1"</span>)] |
| </span><span class="kw">use </span>http::header::{IntoHeaderName, ValueIter}; |
| <span class="kw">use </span>http::HeaderMap; |
| <span class="attribute">#[cfg(feature = <span class="string">"ffi"</span>)] |
| </span><span class="kw">use </span>std::collections::HashMap; |
| <span class="attribute">#[cfg(feature = <span class="string">"http2"</span>)] |
| </span><span class="kw">use </span>std::fmt; |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"ffi"</span>))] |
| </span><span class="kw">mod </span>h1_reason_phrase; |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"ffi"</span>))] |
| </span><span class="kw">pub use </span>h1_reason_phrase::ReasonPhrase; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http2"</span>)] |
| </span><span class="doccomment">/// Represents the `:protocol` pseudo-header used by |
| /// the [Extended CONNECT Protocol]. |
| /// |
| /// [Extended CONNECT Protocol]: https://datatracker.ietf.org/doc/html/rfc8441#section-4 |
| </span><span class="attribute">#[derive(Clone, Eq, PartialEq)] |
| </span><span class="kw">pub struct </span>Protocol { |
| inner: h2::ext::Protocol, |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http2"</span>)] |
| </span><span class="kw">impl </span>Protocol { |
| <span class="doccomment">/// Converts a static string to a protocol name. |
| </span><span class="kw">pub const fn </span>from_static(value: <span class="kw-2">&</span><span class="lifetime">'static </span>str) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| inner: h2::ext::Protocol::from_static(value), |
| } |
| } |
| |
| <span class="doccomment">/// Returns a str representation of the header. |
| </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="self">self</span>.inner.as_str() |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"server"</span>)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_inner(inner: h2::ext::Protocol) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ inner } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>into_inner(<span class="self">self</span>) -> h2::ext::Protocol { |
| <span class="self">self</span>.inner |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http2"</span>)] |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> From<<span class="kw-2">&</span><span class="lifetime">'a </span>str> <span class="kw">for </span>Protocol { |
| <span class="kw">fn </span>from(value: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| inner: h2::ext::Protocol::from(value), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http2"</span>)] |
| </span><span class="kw">impl </span>AsRef<[u8]> <span class="kw">for </span>Protocol { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.inner.as_ref() |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http2"</span>)] |
| </span><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Protocol { |
| <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<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="self">self</span>.inner.fmt(f) |
| } |
| } |
| |
| <span class="doccomment">/// A map from header names to their original casing as received in an HTTP message. |
| /// |
| /// If an HTTP/1 response `res` is parsed on a connection whose option |
| /// [`http1_preserve_header_case`] was set to true and the response included |
| /// the following headers: |
| /// |
| /// ```ignore |
| /// x-Bread: Baguette |
| /// X-BREAD: Pain |
| /// x-bread: Ficelle |
| /// ``` |
| /// |
| /// Then `res.extensions().get::<HeaderCaseMap>()` will return a map with: |
| /// |
| /// ```ignore |
| /// HeaderCaseMap({ |
| /// "x-bread": ["x-Bread", "X-BREAD", "x-bread"], |
| /// }) |
| /// ``` |
| /// |
| /// [`http1_preserve_header_case`]: /client/struct.Client.html#method.http1_preserve_header_case |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>HeaderCaseMap(HeaderMap<Bytes>); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http1"</span>)] |
| </span><span class="kw">impl </span>HeaderCaseMap { |
| <span class="doccomment">/// Returns a view of all spellings associated with that header name, |
| /// in the order they were found. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_all<<span class="lifetime">'a</span>>( |
| <span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, |
| name: <span class="kw-2">&</span>HeaderName, |
| ) -> <span class="kw">impl </span>Iterator<Item = <span class="kw">impl </span>AsRef<[u8]> + <span class="lifetime">'a</span>> + <span class="lifetime">'a </span>{ |
| <span class="self">self</span>.get_all_internal(name).into_iter() |
| } |
| |
| <span class="doccomment">/// Returns a view of all spellings associated with that header name, |
| /// in the order they were found. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_all_internal<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, name: <span class="kw-2">&</span>HeaderName) -> ValueIter<<span class="lifetime">'_</span>, Bytes> { |
| <span class="self">self</span>.<span class="number">0</span>.get_all(name).into_iter() |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>(Default::default()) |
| } |
| |
| <span class="attribute">#[cfg(any(test, feature = <span class="string">"ffi"</span>))] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>insert(<span class="kw-2">&mut </span><span class="self">self</span>, name: HeaderName, orig: Bytes) { |
| <span class="self">self</span>.<span class="number">0</span>.insert(name, orig); |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>append<N>(<span class="kw-2">&mut </span><span class="self">self</span>, name: N, orig: Bytes) |
| <span class="kw">where |
| </span>N: IntoHeaderName, |
| { |
| <span class="self">self</span>.<span class="number">0</span>.append(name, orig); |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"ffi"</span>)] |
| #[derive(Clone, Debug)] |
| </span><span class="doccomment">/// Hashmap<Headername, numheaders with that name> |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>OriginalHeaderOrder { |
| <span class="doccomment">/// Stores how many entries a Headername maps to. This is used |
| /// for accounting. |
| </span>num_entries: HashMap<HeaderName, usize>, |
| <span class="doccomment">/// Stores the ordering of the headers. ex: `vec[i] = (headerName, idx)`, |
| /// The vector is ordered such that the ith element |
| /// represents the ith header that came in off the line. |
| /// The `HeaderName` and `idx` are then used elsewhere to index into |
| /// the multi map that stores the header values. |
| </span>entry_order: Vec<(HeaderName, usize)>, |
| } |
| |
| <span class="attribute">#[cfg(all(feature = <span class="string">"http1"</span>, feature = <span class="string">"ffi"</span>))] |
| </span><span class="kw">impl </span>OriginalHeaderOrder { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| OriginalHeaderOrder { |
| num_entries: HashMap::new(), |
| entry_order: Vec::new(), |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>insert(<span class="kw-2">&mut </span><span class="self">self</span>, name: HeaderName) { |
| <span class="kw">if </span>!<span class="self">self</span>.num_entries.contains_key(<span class="kw-2">&</span>name) { |
| <span class="kw">let </span>idx = <span class="number">0</span>; |
| <span class="self">self</span>.num_entries.insert(name.clone(), <span class="number">1</span>); |
| <span class="self">self</span>.entry_order.push((name, idx)); |
| } |
| <span class="comment">// Replacing an already existing element does not |
| // change ordering, so we only care if its the first |
| // header name encountered |
| </span>} |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>append<N>(<span class="kw-2">&mut </span><span class="self">self</span>, name: N) |
| <span class="kw">where |
| </span>N: IntoHeaderName + Into<HeaderName> + Clone, |
| { |
| <span class="kw">let </span>name: HeaderName = name.into(); |
| <span class="kw">let </span>idx; |
| <span class="kw">if </span><span class="self">self</span>.num_entries.contains_key(<span class="kw-2">&</span>name) { |
| idx = <span class="self">self</span>.num_entries[<span class="kw-2">&</span>name]; |
| <span class="kw-2">*</span><span class="self">self</span>.num_entries.get_mut(<span class="kw-2">&</span>name).unwrap() += <span class="number">1</span>; |
| } <span class="kw">else </span>{ |
| idx = <span class="number">0</span>; |
| <span class="self">self</span>.num_entries.insert(name.clone(), <span class="number">1</span>); |
| } |
| <span class="self">self</span>.entry_order.push((name, idx)); |
| } |
| |
| <span class="comment">// No doc test is run here because `RUSTFLAGS='--cfg hyper_unstable_ffi'` |
| // is needed to compile. Once ffi is stablized `no_run` should be removed |
| // here. |
| </span><span class="doccomment">/// This returns an iterator that provides header names and indexes |
| /// in the original order received. |
| /// |
| /// # Examples |
| /// ```no_run |
| /// use hyper::ext::OriginalHeaderOrder; |
| /// use hyper::header::{HeaderName, HeaderValue, HeaderMap}; |
| /// |
| /// let mut h_order = OriginalHeaderOrder::default(); |
| /// let mut h_map = Headermap::new(); |
| /// |
| /// let name1 = b"Set-CookiE"; |
| /// let value1 = b"a=b"; |
| /// h_map.append(name1); |
| /// h_order.append(name1); |
| /// |
| /// let name2 = b"Content-Encoding"; |
| /// let value2 = b"gzip"; |
| /// h_map.append(name2, value2); |
| /// h_order.append(name2); |
| /// |
| /// let name3 = b"SET-COOKIE"; |
| /// let value3 = b"c=d"; |
| /// h_map.append(name3, value3); |
| /// h_order.append(name3) |
| /// |
| /// let mut iter = h_order.get_in_order() |
| /// |
| /// let (name, idx) = iter.next(); |
| /// assert_eq!(b"a=b", h_map.get_all(name).nth(idx).unwrap()); |
| /// |
| /// let (name, idx) = iter.next(); |
| /// assert_eq!(b"gzip", h_map.get_all(name).nth(idx).unwrap()); |
| /// |
| /// let (name, idx) = iter.next(); |
| /// assert_eq!(b"c=d", h_map.get_all(name).nth(idx).unwrap()); |
| /// ``` |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_in_order(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = <span class="kw-2">&</span>(HeaderName, usize)> { |
| <span class="self">self</span>.entry_order.iter() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
