Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,7 +1,7 @@
|
||||
<!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="HTTP header types"><meta name="keywords" content="rust, rustlang, rust-lang, header"><title>http::header - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<!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="API documentation for the Rust `header` mod in crate `http`."><meta name="keywords" content="rust, rustlang, rust-lang, header"><title>http::header - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../http/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module header</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../index.html">http</a></p><div id="sidebar-vars" data-name="header" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">http</a>::<wbr><a class="mod" href="">header</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/http/header/mod.rs.html#1-172" title="goto source code">[src]</a></span></h1><div class="docblock"><p>HTTP header types</p>
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../http/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module header</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../index.html">http</a></p><script>window.sidebarCurrent = {name: "header", ty: "mod", relpath: "../"};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/http/header/mod.rs.html#1-172" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../index.html">http</a>::<wbr><a class="mod" href="">header</a></span></h1><div class="docblock"><p>HTTP header types</p>
|
||||
<p>The module provides <a href="struct.HeaderName.html"><code>HeaderName</code></a>, <a href="struct.HeaderMap.html"><code>HeaderMap</code></a>, and a number of types
|
||||
used for interacting with <code>HeaderMap</code>. These types allow representing both
|
||||
HTTP/1 and HTTP/2 headers.</p>
|
||||
@@ -28,14 +28,14 @@ cases common with HTTP. It is a <a href="https://en.wikipedia.org/wiki/Multimap"
|
||||
may have multiple associated header values. Given this, some of the APIs
|
||||
diverge from <a href="https://doc.rust-lang.org/std/collections/struct.HashMap.html"><code>HashMap</code></a>.</p>
|
||||
<h2 id="overview" class="section-header"><a href="#overview">Overview</a></h2>
|
||||
<p>Just like <code>HashMap</code> in Rust’s stdlib, <code>HeaderMap</code> is based on <a href="https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing">Robin Hood
|
||||
<p>Just like <code>HashMap</code> in Rust's stdlib, <code>HeaderMap</code> is based on <a href="https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing">Robin Hood
|
||||
hashing</a>. 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.</p>
|
||||
<h2 id="deterministic-ordering" class="section-header"><a href="#deterministic-ordering">Deterministic ordering</a></h2>
|
||||
<p>Unlike Rust’s <code>HashMap</code>, values in <code>HeaderMap</code> are deterministically
|
||||
<p>Unlike Rust's <code>HashMap</code>, values in <code>HeaderMap</code> 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.</p>
|
||||
@@ -113,7 +113,7 @@ given page.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.COOKIE.html" title="http::header::COOKIE constant">COOKIE</a></td><td class="docblock-short"><p>Contains stored HTTP cookies previously sent by the server with the
|
||||
Set-Cookie header.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.DATE.html" title="http::header::DATE constant">DATE</a></td><td class="docblock-short"><p>Contains the date and time at which the message was originated.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.DNT.html" title="http::header::DNT constant">DNT</a></td><td class="docblock-short"><p>Indicates the client’s tracking preference.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.DNT.html" title="http::header::DNT constant">DNT</a></td><td class="docblock-short"><p>Indicates the client's tracking preference.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.ETAG.html" title="http::header::ETAG constant">ETAG</a></td><td class="docblock-short"><p>Identifier for a specific version of a resource.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.EXPECT.html" title="http::header::EXPECT constant">EXPECT</a></td><td class="docblock-short"><p>Indicates expectations that need to be fulfilled by the server in order
|
||||
to properly handle the request.</p>
|
||||
@@ -193,7 +193,7 @@ client.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.UPGRADE.html" title="http::header::UPGRADE constant">UPGRADE</a></td><td class="docblock-short"><p>Used as part of the exchange to upgrade the protocol.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.UPGRADE_INSECURE_REQUESTS.html" title="http::header::UPGRADE_INSECURE_REQUESTS constant">UPGRADE_INSECURE_REQUESTS</a></td><td class="docblock-short"><p>Sends a signal to the server expressing the client’s preference for an
|
||||
encrypted and authenticated response.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.USER_AGENT.html" title="http::header::USER_AGENT constant">USER_AGENT</a></td><td class="docblock-short"><p>Contains a string that allows identifying the requesting client’s
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.USER_AGENT.html" title="http::header::USER_AGENT constant">USER_AGENT</a></td><td class="docblock-short"><p>Contains a string that allows identifying the requesting client's
|
||||
software.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.VARY.html" title="http::header::VARY constant">VARY</a></td><td class="docblock-short"><p>Determines how to match future requests with cached responses.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.VIA.html" title="http::header::VIA constant">VIA</a></td><td class="docblock-short"><p>Added by proxies to track routing.</p>
|
||||
@@ -212,5 +212,4 @@ a frame.</p>
|
||||
to a <code>HeaderMap</code>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.IntoHeaderName.html" title="http::header::IntoHeaderName trait">IntoHeaderName</a></td><td class="docblock-short"><p>A marker trait used to identify values that can be used as insert keys
|
||||
to a <code>HeaderMap</code>.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "http";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user