| <!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/header/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="../../../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> |
| </pre><pre class="rust"><code><span class="doccomment">//! HTTP header types |
| //! |
| //! The module provides [`HeaderName`], [`HeaderMap`], and a number of types |
| //! used for interacting with `HeaderMap`. These types allow representing both |
| //! HTTP/1 and HTTP/2 headers. |
| //! |
| //! # `HeaderName` |
| //! |
| //! The `HeaderName` type represents both standard header names as well as |
| //! custom header names. The type handles the case insensitive nature of header |
| //! names and is used as the key portion of `HeaderMap`. Header names are |
| //! normalized to lower case. In other words, when creating a `HeaderName` with |
| //! a string, even if upper case characters are included, when getting a string |
| //! representation of the `HeaderName`, it will be all lower case. This allows |
| //! for faster `HeaderMap` comparison operations. |
| //! |
| //! The internal representation is optimized to efficiently handle the cases |
| //! most commonly encountered when working with HTTP. Standard header names are |
| //! special cased and are represented internally as an enum. Short custom |
| //! headers will be stored directly in the `HeaderName` struct and will not |
| //! incur any allocation overhead, however longer strings will require an |
| //! allocation for storage. |
| //! |
| //! ## Limitations |
| //! |
| //! `HeaderName` has a max length of 32,768 for header names. Attempting to |
| //! parse longer names will result in a panic. |
| //! |
| //! # `HeaderMap` |
| //! |
| //! `HeaderMap` is a map structure of header names highly optimized for use |
| //! cases common with HTTP. It is a [multimap] structure, where each header name |
| //! may have multiple associated header values. Given this, some of the APIs |
| //! diverge from [`HashMap`]. |
| //! |
| //! ## Overview |
| //! |
| //! Just like `HashMap` in Rust's stdlib, `HeaderMap` is based on [Robin Hood |
| //! hashing]. This algorithm tends to reduce the worst case search times in the |
| //! table and enables high load factors without seriously affecting performance. |
| //! Internally, keys and values are stored in vectors. As such, each insertion |
| //! will not incur allocation overhead. However, once the underlying vector |
| //! storage is full, a larger vector must be allocated and all values copied. |
| //! |
| //! ## Deterministic ordering |
| //! |
| //! Unlike Rust's `HashMap`, values in `HeaderMap` are deterministically |
| //! ordered. Roughly, values are ordered by insertion. This means that a |
| //! function that deterministically operates on a header map can rely on the |
| //! iteration order to remain consistent across processes and platforms. |
| //! |
| //! ## Adaptive hashing |
| //! |
| //! `HeaderMap` uses an adaptive hashing strategy in order to efficiently handle |
| //! most common cases. All standard headers have statically computed hash values |
| //! which removes the need to perform any hashing of these headers at runtime. |
| //! The default hash function emphasizes performance over robustness. However, |
| //! `HeaderMap` detects high collision rates and switches to a secure hash |
| //! function in those events. The threshold is set such that only denial of |
| //! service attacks should trigger it. |
| //! |
| //! ## Limitations |
| //! |
| //! `HeaderMap` can store a maximum of 32,768 headers (header name / value |
| //! pairs). Attempting to insert more will result in a panic. |
| //! |
| //! [`HeaderName`]: struct.HeaderName.html |
| //! [`HeaderMap`]: struct.HeaderMap.html |
| //! [multimap]: https://en.wikipedia.org/wiki/Multimap |
| //! [`HashMap`]: https://doc.rust-lang.org/std/collections/struct.HashMap.html |
| //! [Robin Hood hashing]: https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing |
| |
| </span><span class="kw">mod </span>map; |
| <span class="kw">mod </span>name; |
| <span class="kw">mod </span>value; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::map::{ |
| AsHeaderName, Drain, Entry, GetAll, HeaderMap, IntoHeaderName, IntoIter, Iter, IterMut, Keys, |
| OccupiedEntry, VacantEntry, ValueDrain, ValueIter, ValueIterMut, Values, ValuesMut, |
| }; |
| <span class="kw">pub use </span><span class="self">self</span>::name::{HeaderName, InvalidHeaderName}; |
| <span class="kw">pub use </span><span class="self">self</span>::value::{HeaderValue, InvalidHeaderValue, ToStrError}; |
| |
| <span class="comment">// Use header name constants |
| </span><span class="kw">pub use </span><span class="self">self</span>::name::{ |
| ACCEPT, |
| ACCEPT_CHARSET, |
| ACCEPT_ENCODING, |
| ACCEPT_LANGUAGE, |
| ACCEPT_RANGES, |
| ACCESS_CONTROL_ALLOW_CREDENTIALS, |
| ACCESS_CONTROL_ALLOW_HEADERS, |
| ACCESS_CONTROL_ALLOW_METHODS, |
| ACCESS_CONTROL_ALLOW_ORIGIN, |
| ACCESS_CONTROL_EXPOSE_HEADERS, |
| ACCESS_CONTROL_MAX_AGE, |
| ACCESS_CONTROL_REQUEST_HEADERS, |
| ACCESS_CONTROL_REQUEST_METHOD, |
| AGE, |
| ALLOW, |
| ALT_SVC, |
| AUTHORIZATION, |
| CACHE_CONTROL, |
| CACHE_STATUS, |
| CDN_CACHE_CONTROL, |
| CONNECTION, |
| CONTENT_DISPOSITION, |
| CONTENT_ENCODING, |
| CONTENT_LANGUAGE, |
| CONTENT_LENGTH, |
| CONTENT_LOCATION, |
| CONTENT_RANGE, |
| CONTENT_SECURITY_POLICY, |
| CONTENT_SECURITY_POLICY_REPORT_ONLY, |
| CONTENT_TYPE, |
| COOKIE, |
| DNT, |
| DATE, |
| ETAG, |
| EXPECT, |
| EXPIRES, |
| FORWARDED, |
| FROM, |
| HOST, |
| IF_MATCH, |
| IF_MODIFIED_SINCE, |
| IF_NONE_MATCH, |
| IF_RANGE, |
| IF_UNMODIFIED_SINCE, |
| LAST_MODIFIED, |
| LINK, |
| LOCATION, |
| MAX_FORWARDS, |
| ORIGIN, |
| PRAGMA, |
| PROXY_AUTHENTICATE, |
| PROXY_AUTHORIZATION, |
| PUBLIC_KEY_PINS, |
| PUBLIC_KEY_PINS_REPORT_ONLY, |
| RANGE, |
| REFERER, |
| REFERRER_POLICY, |
| REFRESH, |
| RETRY_AFTER, |
| SEC_WEBSOCKET_ACCEPT, |
| SEC_WEBSOCKET_EXTENSIONS, |
| SEC_WEBSOCKET_KEY, |
| SEC_WEBSOCKET_PROTOCOL, |
| SEC_WEBSOCKET_VERSION, |
| SERVER, |
| SET_COOKIE, |
| STRICT_TRANSPORT_SECURITY, |
| TE, |
| TRAILER, |
| TRANSFER_ENCODING, |
| UPGRADE, |
| UPGRADE_INSECURE_REQUESTS, |
| USER_AGENT, |
| VARY, |
| VIA, |
| WARNING, |
| WWW_AUTHENTICATE, |
| X_CONTENT_TYPE_OPTIONS, |
| X_DNS_PREFETCH_CONTROL, |
| X_FRAME_OPTIONS, |
| X_XSS_PROTECTION, |
| }; |
| |
| <span class="doccomment">/// Maximum length of a header name |
| /// |
| /// Generally, 64kb for a header name is WAY too much than would ever be needed |
| /// in practice. Restricting it to this size enables using `u16` values to |
| /// represent offsets when dealing with header names. |
| </span><span class="kw">const </span>MAX_HEADER_NAME_LEN: usize = (<span class="number">1 </span><< <span class="number">16</span>) - <span class="number">1</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> |
