| <!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/http-0.2.9/src/extensions.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>extensions.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="../../http/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="../../http/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::any::{Any, TypeId}; |
| <span class="kw">use </span>std::collections::HashMap; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::hash::{BuildHasherDefault, Hasher}; |
| |
| <span class="kw">type </span>AnyMap = HashMap<TypeId, Box<<span class="kw">dyn </span>Any + Send + Sync>, BuildHasherDefault<IdHasher>>; |
| |
| <span class="comment">// With TypeIds as keys, there's no need to hash them. They are already hashes |
| // themselves, coming from the compiler. The IdHasher just holds the u64 of |
| // the TypeId, and then returns it, instead of doing any bit fiddling. |
| </span><span class="attribute">#[derive(Default)] |
| </span><span class="kw">struct </span>IdHasher(u64); |
| |
| <span class="kw">impl </span>Hasher <span class="kw">for </span>IdHasher { |
| <span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>[u8]) { |
| <span class="macro">unreachable!</span>(<span class="string">"TypeId calls write_u64"</span>); |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>write_u64(<span class="kw-2">&mut </span><span class="self">self</span>, id: u64) { |
| <span class="self">self</span>.<span class="number">0 </span>= id; |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>finish(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="doccomment">/// A type map of protocol extensions. |
| /// |
| /// `Extensions` can be used by `Request` and `Response` to store |
| /// extra data derived from the underlying protocol. |
| </span><span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>Extensions { |
| <span class="comment">// If extensions are never used, no need to carry around an empty HashMap. |
| // That's 3 words. Instead, this is only 1 word. |
| </span>map: <span class="prelude-ty">Option</span><Box<AnyMap>>, |
| } |
| |
| <span class="kw">impl </span>Extensions { |
| <span class="doccomment">/// Create an empty `Extensions`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new() -> Extensions { |
| Extensions { map: <span class="prelude-val">None </span>} |
| } |
| |
| <span class="doccomment">/// Insert a type into this `Extensions`. |
| /// |
| /// If a extension of this type already existed, it will |
| /// be returned. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// assert!(ext.insert(5i32).is_none()); |
| /// assert!(ext.insert(4u8).is_none()); |
| /// assert_eq!(ext.insert(9i32), Some(5i32)); |
| /// ``` |
| </span><span class="kw">pub fn </span>insert<T: Send + Sync + <span class="lifetime">'static</span>>(<span class="kw-2">&mut </span><span class="self">self</span>, val: T) -> <span class="prelude-ty">Option</span><T> { |
| <span class="self">self</span>.map |
| .get_or_insert_with(|| Box::new(HashMap::default())) |
| .insert(TypeId::of::<T>(), Box::new(val)) |
| .and_then(|boxed| { |
| (boxed <span class="kw">as </span>Box<<span class="kw">dyn </span>Any + <span class="lifetime">'static</span>>) |
| .downcast() |
| .ok() |
| .map(|boxed| <span class="kw-2">*</span>boxed) |
| }) |
| } |
| |
| <span class="doccomment">/// Get a reference to a type previously inserted on this `Extensions`. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// assert!(ext.get::<i32>().is_none()); |
| /// ext.insert(5i32); |
| /// |
| /// assert_eq!(ext.get::<i32>(), Some(&5i32)); |
| /// ``` |
| </span><span class="kw">pub fn </span>get<T: Send + Sync + <span class="lifetime">'static</span>>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>T> { |
| <span class="self">self</span>.map |
| .as_ref() |
| .and_then(|map| map.get(<span class="kw-2">&</span>TypeId::of::<T>())) |
| .and_then(|boxed| (<span class="kw-2">&**</span>boxed <span class="kw">as </span><span class="kw-2">&</span>(<span class="kw">dyn </span>Any + <span class="lifetime">'static</span>)).downcast_ref()) |
| } |
| |
| <span class="doccomment">/// Get a mutable reference to a type previously inserted on this `Extensions`. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// ext.insert(String::from("Hello")); |
| /// ext.get_mut::<String>().unwrap().push_str(" World"); |
| /// |
| /// assert_eq!(ext.get::<String>().unwrap(), "Hello World"); |
| /// ``` |
| </span><span class="kw">pub fn </span>get_mut<T: Send + Sync + <span class="lifetime">'static</span>>(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&mut </span>T> { |
| <span class="self">self</span>.map |
| .as_mut() |
| .and_then(|map| map.get_mut(<span class="kw-2">&</span>TypeId::of::<T>())) |
| .and_then(|boxed| (<span class="kw-2">&mut **</span>boxed <span class="kw">as </span><span class="kw-2">&mut </span>(<span class="kw">dyn </span>Any + <span class="lifetime">'static</span>)).downcast_mut()) |
| } |
| |
| <span class="doccomment">/// Remove a type from this `Extensions`. |
| /// |
| /// If a extension of this type existed, it will be returned. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// ext.insert(5i32); |
| /// assert_eq!(ext.remove::<i32>(), Some(5i32)); |
| /// assert!(ext.get::<i32>().is_none()); |
| /// ``` |
| </span><span class="kw">pub fn </span>remove<T: Send + Sync + <span class="lifetime">'static</span>>(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><T> { |
| <span class="self">self</span>.map |
| .as_mut() |
| .and_then(|map| map.remove(<span class="kw-2">&</span>TypeId::of::<T>())) |
| .and_then(|boxed| { |
| (boxed <span class="kw">as </span>Box<<span class="kw">dyn </span>Any + <span class="lifetime">'static</span>>) |
| .downcast() |
| .ok() |
| .map(|boxed| <span class="kw-2">*</span>boxed) |
| }) |
| } |
| |
| <span class="doccomment">/// Clear the `Extensions` of all inserted extensions. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// ext.insert(5i32); |
| /// ext.clear(); |
| /// |
| /// assert!(ext.get::<i32>().is_none()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>clear(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>map) = <span class="self">self</span>.map { |
| map.clear(); |
| } |
| } |
| |
| <span class="doccomment">/// Check whether the extension set is empty or not. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// assert!(ext.is_empty()); |
| /// ext.insert(5i32); |
| /// assert!(!ext.is_empty()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.map |
| .as_ref() |
| .map_or(<span class="bool-val">true</span>, |map| map.is_empty()) |
| } |
| |
| <span class="doccomment">/// Get the numer of extensions available. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext = Extensions::new(); |
| /// assert_eq!(ext.len(), 0); |
| /// ext.insert(5i32); |
| /// assert_eq!(ext.len(), 1); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.map |
| .as_ref() |
| .map_or(<span class="number">0</span>, |map| map.len()) |
| } |
| |
| <span class="doccomment">/// Extends `self` with another `Extensions`. |
| /// |
| /// If an instance of a specific type exists in both, the one in `self` is overwritten with the |
| /// one from `other`. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// # use http::Extensions; |
| /// let mut ext_a = Extensions::new(); |
| /// ext_a.insert(8u8); |
| /// ext_a.insert(16u16); |
| /// |
| /// let mut ext_b = Extensions::new(); |
| /// ext_b.insert(4u8); |
| /// ext_b.insert("hello"); |
| /// |
| /// ext_a.extend(ext_b); |
| /// assert_eq!(ext_a.len(), 3); |
| /// assert_eq!(ext_a.get::<u8>(), Some(&4u8)); |
| /// assert_eq!(ext_a.get::<u16>(), Some(&16u16)); |
| /// assert_eq!(ext_a.get::<&'static str>().copied(), Some("hello")); |
| /// ``` |
| </span><span class="kw">pub fn </span>extend(<span class="kw-2">&mut </span><span class="self">self</span>, other: <span class="self">Self</span>) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(other) = other.map { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(map) = <span class="kw-2">&mut </span><span class="self">self</span>.map { |
| map.extend(<span class="kw-2">*</span>other); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.map = <span class="prelude-val">Some</span>(other); |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Extensions { |
| <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 { |
| f.debug_struct(<span class="string">"Extensions"</span>).finish() |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_extensions() { |
| <span class="attribute">#[derive(Debug, PartialEq)] |
| </span><span class="kw">struct </span>MyType(i32); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>extensions = Extensions::new(); |
| |
| extensions.insert(<span class="number">5i32</span>); |
| extensions.insert(MyType(<span class="number">10</span>)); |
| |
| <span class="macro">assert_eq!</span>(extensions.get(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">5i32</span>)); |
| <span class="macro">assert_eq!</span>(extensions.get_mut(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span><span class="number">5i32</span>)); |
| |
| <span class="macro">assert_eq!</span>(extensions.remove::<i32>(), <span class="prelude-val">Some</span>(<span class="number">5i32</span>)); |
| <span class="macro">assert!</span>(extensions.get::<i32>().is_none()); |
| |
| <span class="macro">assert_eq!</span>(extensions.get::<bool>(), <span class="prelude-val">None</span>); |
| <span class="macro">assert_eq!</span>(extensions.get(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>MyType(<span class="number">10</span>))); |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
