mirror of
https://github.com/actix/actix-website
synced 2024-11-25 09:12:42 +01:00
77 lines
23 KiB
HTML
77 lines
23 KiB
HTML
<!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 `Entry` enum in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Entry"><title>actix_web::http::header::Entry - 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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script></head><body class="rustdoc enum"><!--[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><p class='location'>Enum Entry</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Occupied">Occupied</a><a href="#variant.Vacant">Vacant</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.or_insert">or_insert</a><a href="#method.or_insert_with">or_insert_with</a><a href="#method.key">key</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>header</a></p><script>window.sidebarCurrent = {name: 'Entry', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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'>Enum <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>header</a>::<wbr><a class="enum" href=''>Entry</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='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#147-153' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum Entry<'a, T> <span class="where fmt-newline">where<br> T: 'a, </span> {
|
||
Occupied(<a class="struct" href="../../../actix_web/http/header/struct.OccupiedEntry.html" title="struct actix_web::http::header::OccupiedEntry">OccupiedEntry</a><'a, T>),
|
||
Vacant(<a class="struct" href="../../../actix_web/http/header/struct.VacantEntry.html" title="struct actix_web::http::header::VacantEntry">VacantEntry</a><'a, T>),
|
||
}</pre></div><div class='docblock'><p>A view into a single location in a <code>HeaderMap</code>, which may be vacant or occupied.</p>
|
||
</div><h2 id='variants' class='variants small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.Occupied" class="variant small-section-header"><a href="#variant.Occupied" class="anchor field"></a><span id='Occupied.v' class='invisible'><code>Occupied(<a class="struct" href="../../../actix_web/http/header/struct.OccupiedEntry.html" title="struct actix_web::http::header::OccupiedEntry">OccupiedEntry</a><'a, T>)</code></span></span><div class='docblock'><p>An occupied entry</p>
|
||
</div><span id="variant.Vacant" class="variant small-section-header"><a href="#variant.Vacant" class="anchor field"></a><span id='Vacant.v' class='invisible'><code>Vacant(<a class="struct" href="../../../actix_web/http/header/struct.VacantEntry.html" title="struct actix_web::http::header::VacantEntry">VacantEntry</a><'a, T>)</code></span></span><div class='docblock'><p>A vacant entry</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T> <a class="enum" href="../../../actix_web/http/header/enum.Entry.html" title="enum actix_web::http::header::Entry">Entry</a><'a, T></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#2084-2183' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.or_insert' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='or_insert.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.or_insert' class='fnname'>or_insert</a>(self, default: T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#2112-2119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Ensures a value is in the entry by inserting the default if empty.</p>
|
||
<p>Returns a mutable reference to the <strong>first</strong> value in the entry.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HeaderMap</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span> <span class="op">=</span> <span class="ident">HeaderMap</span>::<span class="ident">default</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">headers</span> <span class="op">=</span> <span class="kw-2">&</span>[
|
||
<span class="string">"content-length"</span>,
|
||
<span class="string">"x-hello"</span>,
|
||
<span class="string">"Content-Length"</span>,
|
||
<span class="string">"x-world"</span>,
|
||
];
|
||
|
||
<span class="kw">for</span> <span class="kw-2">&</span><span class="ident">header</span> <span class="kw">in</span> <span class="ident">headers</span> {
|
||
<span class="kw">let</span> <span class="ident">counter</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="ident">header</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"valid header names"</span>)
|
||
.<span class="ident">or_insert</span>(<span class="number">0</span>);
|
||
<span class="kw-2">*</span><span class="ident">counter</span> <span class="op">+=</span> <span class="number">1</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"content-length"</span>], <span class="number">2</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">"x-hello"</span>], <span class="number">1</span>);</pre>
|
||
</div><h4 id='method.or_insert_with' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='or_insert_with.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.or_insert_with' class='fnname'>or_insert_with</a><F>(self, default: F) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#2156-2163' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Ensures a value is in the entry by inserting the result of the default
|
||
function if empty.</p>
|
||
<p>The default function is not called if the entry exists in the map.
|
||
Returns a mutable reference to the <strong>first</strong> value in the entry.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<p>Basic usage.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">HeaderMap</span>::<span class="ident">new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"x-hello"</span>).<span class="ident">unwrap</span>()
|
||
.<span class="ident">or_insert_with</span>(<span class="op">||</span> <span class="string">"world"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>());
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">res</span>, <span class="string">"world"</span>);</pre>
|
||
<p>The default function is not called if the entry exists in the map.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">HeaderMap</span>::<span class="ident">new</span>();
|
||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="ident">HOST</span>, <span class="string">"world"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>());
|
||
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"host"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"host is a valid string"</span>)
|
||
.<span class="ident">or_insert_with</span>(<span class="op">||</span> <span class="macro">unreachable</span><span class="macro">!</span>());
|
||
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">res</span>, <span class="string">"world"</span>);</pre>
|
||
</div><h4 id='method.key' class="method"><span id='key.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.key' class='fnname'>key</a>(&self) -> &<a class="struct" href="../../../actix_web/http/header/struct.HeaderName.html" title="struct actix_web::http::header::HeaderName">HeaderName</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#2175-2182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the entry's key</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">HeaderMap</span>::<span class="ident">new</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">"x-hello"</span>).<span class="ident">unwrap</span>().<span class="ident">key</span>(), <span class="string">"x-hello"</span>);</pre>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../../actix_web/http/header/enum.Entry.html" title="enum actix_web::http::header::Entry">Entry</a><'a, T> <span class="where fmt-newline">where<br> T: 'a + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, </span></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#146' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/http/0.1.7/src/http/header/map.rs.html#146' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div></div>
|
||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='synthetic-implementations-list'>
|
||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../../actix_web/http/header/enum.Entry.html" title="enum actix_web::http::header::Entry">Entry</a><'a, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../../actix_web/http/header/enum.Entry.html" title="enum actix_web::http::header::Entry">Entry</a><'a, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |