actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2024-11-25 01:02:58 +01:00
Code Issues Releases Wiki Activity
29977f4930
actix-website/static/api/actix-web/0.7.2/actix_web/http/struct.Cookie.html
Nikolay Kim 90165ac1cc update stable docs
2018-07-26 10:53:41 -07:00

437 lines
86 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `Cookie` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Cookie"><title>actix_web::http::Cookie - 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 struct"><!--[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">&#9776;</div><p class='location'>Struct Cookie</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.named">named</a><a href="#method.build">build</a><a href="#method.parse">parse</a><a href="#method.parse_encoded">parse_encoded</a><a href="#method.encoded">encoded</a><a href="#method.into_owned">into_owned</a><a href="#method.name">name</a><a href="#method.value">value</a><a href="#method.name_value">name_value</a><a href="#method.http_only">http_only</a><a href="#method.secure">secure</a><a href="#method.same_site">same_site</a><a href="#method.max_age">max_age</a><a href="#method.path">path</a><a href="#method.domain">domain</a><a href="#method.expires">expires</a><a href="#method.set_name">set_name</a><a href="#method.set_value">set_value</a><a href="#method.set_http_only">set_http_only</a><a href="#method.set_secure">set_secure</a><a href="#method.set_same_site">set_same_site</a><a href="#method.set_max_age">set_max_age</a><a href="#method.set_path">set_path</a><a href="#method.set_domain">set_domain</a><a href="#method.set_expires">set_expires</a><a href="#method.make_permanent">make_permanent</a><a href="#method.name_raw">name_raw</a><a href="#method.value_raw">value_raw</a><a href="#method.path_raw">path_raw</a><a href="#method.domain_raw">domain_raw</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Display">Display</a><a href="#impl-PartialEq%3CCookie%3C%27b%3E%3E">PartialEq&lt;Cookie&lt;&#39;b&gt;&gt;</a><a href="#impl-Clone">Clone</a><a href="#impl-FromStr">FromStr</a><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></p><script>window.sidebarCurrent = {name: 'Cookie', ty: 'struct', 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'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>http</a>::<wbr><a class="struct" href=''>Cookie</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'>&#x2212;</span>]</a></span><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#161-183' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Cookie&lt;'c&gt; { /* fields omitted */ }</pre></div><div class='docblock'><p>Representation of an HTTP cookie.</p>
<h1 id="constructing-a-cookie" class="section-header"><a href="#constructing-a-cookie">Constructing a <code>Cookie</code></a></h1>
<p>To construct a cookie with only a name/value, use the <a href="#method.new">new</a>
method:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="ident">cookie</span>.<span class="ident">to_string</span>(), <span class="string">&quot;name=value&quot;</span>);</pre>
<p>To construct more elaborate cookies, use the <a href="#method.build">build</a> method
and <a href="struct.CookieBuilder.html"><code>CookieBuilder</code></a> methods:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>)
.<span class="ident">domain</span>(<span class="string">&quot;www.rust-lang.org&quot;</span>)
.<span class="ident">path</span>(<span class="string">&quot;/&quot;</span>)
.<span class="ident">secure</span>(<span class="bool-val">true</span>)
.<span class="ident">http_only</span>(<span class="bool-val">true</span>)
.<span class="ident">finish</span>();</pre>
</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 class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'static&gt;</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/cookie/0.11/src/cookie/lib.rs.html#185-248' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>&lt;N, V&gt;(name: N, value: V) -&gt; <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'static&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#196-212' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>Cookie</code> with the given name and value.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cookie</span>.<span class="ident">name_value</span>(), (<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>));</pre>
</div><h4 id='method.named' class="method"><span id='named.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.named' class='fnname'>named</a>&lt;N&gt;(name: N) -&gt; <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'static&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#225-229' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>Cookie</code> with the given name and an empty value.</p>
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">named</span>(<span class="string">&quot;name&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cookie</span>.<span class="ident">name</span>(), <span class="string">&quot;name&quot;</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">cookie</span>.<span class="ident">value</span>().<span class="ident">is_empty</span>());</pre>
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</a>&lt;N, V&gt;(name: N, value: V) -&gt; <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#242-247' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>CookieBuilder</code> instance from the given key and value
strings.</p>
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>).<span class="ident">finish</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name_value</span>(), (<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>));</pre>
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'c&gt; <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#250-906' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse' class='fnname'>parse</a>&lt;S&gt;(s: S) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;, <a class="enum" href="../../actix_web/error/enum.CookieParseError.html" title="enum actix_web::error::CookieParseError">ParseError</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'c, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#263-267' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parses a <code>Cookie</code> from the given HTTP cookie header value string. Does
not perform any percent-decoding.</p>
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;foo=bar%20baz; HttpOnly&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name_value</span>(), (<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar%20baz&quot;</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));</pre>
</div><h4 id='method.parse_encoded' class="method"><span id='parse_encoded.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse_encoded' class='fnname'>parse_encoded</a>&lt;S&gt;(s: S) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;, <a class="enum" href="../../actix_web/error/enum.CookieParseError.html" title="enum actix_web::error::CookieParseError">ParseError</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'c, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#286-290' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parses a <code>Cookie</code> from the given HTTP cookie header value string where
the name and value fields are percent-encoded. Percent-decodes the
name/value fields.</p>
<p>This API requires the <code>percent-encode</code> feature to be enabled on this
crate.</p>
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse_encoded</span>(<span class="string">&quot;foo=bar%20baz; HttpOnly&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name_value</span>(), (<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar baz&quot;</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));</pre>
</div><h4 id='method.encoded' class="method"><span id='encoded.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.encoded' class='fnname'>encoded</a>(&amp;'a self) -&gt; <a class="struct" href="https://docs.rs/cookie/0.11/cookie/struct.EncodedCookie.html" title="struct cookie::EncodedCookie">EncodedCookie</a>&lt;'a, 'c&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#308-310' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Wraps <code>self</code> in an <code>EncodedCookie</code>: a cost-free wrapper around <code>Cookie</code>
whose <code>Display</code> implementation percent-encodes the name and value of the
wrapped <code>Cookie</code>.</p>
<p>This method is only available when the <code>percent-encode</code> feature is
enabled.</p>
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;my name&quot;</span>, <span class="string">&quot;this; value?&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="ident">c</span>.<span class="ident">encoded</span>().<span class="ident">to_string</span>(), <span class="string">&quot;my%20name=this%3B%20value%3F&quot;</span>);</pre>
</div><h4 id='method.into_owned' class="method"><span id='into_owned.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.into_owned' class='fnname'>into_owned</a>(self) -&gt; <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'static&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#324-337' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts <code>self</code> into a <code>Cookie</code> with a static lifetime. This method
results in at most one allocation.</p>
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;a&quot;</span>, <span class="string">&quot;b&quot;</span>);
<span class="kw">let</span> <span class="ident">owned_cookie</span> <span class="op">=</span> <span class="ident">c</span>.<span class="ident">into_owned</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">owned_cookie</span>.<span class="ident">name_value</span>(), (<span class="string">&quot;a&quot;</span>, <span class="string">&quot;b&quot;</span>));</pre>
</div><h4 id='method.name' class="method"><span id='name.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.name' class='fnname'>name</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#350-352' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the name of <code>self</code>.</p>
<h1 id="example-7" class="section-header"><a href="#example-7">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name</span>(), <span class="string">&quot;name&quot;</span>);</pre>
</div><h4 id='method.value' class="method"><span id='value.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.value' class='fnname'>value</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#365-367' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the value of <code>self</code>.</p>
<h1 id="example-8" class="section-header"><a href="#example-8">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">value</span>(), <span class="string">&quot;value&quot;</span>);</pre>
</div><h4 id='method.name_value' class="method"><span id='name_value.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.name_value' class='fnname'>name_value</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#380-382' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the name and value of <code>self</code> as a tuple of <code>(name, value)</code>.</p>
<h1 id="example-9" class="section-header"><a href="#example-9">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name_value</span>(), (<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>));</pre>
</div><h4 id='method.http_only' class="method"><span id='http_only.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.http_only' class='fnname'>http_only</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#412-414' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns whether this cookie was marked <code>HttpOnly</code> or not. Returns
<code>Some(true)</code> when the cookie was explicitly set (manually or parsed) as
<code>HttpOnly</code>, <code>Some(false)</code> when <code>http_only</code> was manually set to <code>false</code>,
and <code>None</code> otherwise.</p>
<h1 id="example-10" class="section-header"><a href="#example-10">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; httponly&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">None</span>);
<span class="comment">// An explicitly set &quot;false&quot; value.</span>
<span class="ident">c</span>.<span class="ident">set_http_only</span>(<span class="bool-val">false</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">false</span>));
<span class="comment">// An explicitly set &quot;true&quot; value.</span>
<span class="ident">c</span>.<span class="ident">set_http_only</span>(<span class="bool-val">true</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));</pre>
</div><h4 id='method.secure' class="method"><span id='secure.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.secure' class='fnname'>secure</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#444-446' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns whether this cookie was marked <code>Secure</code> or not. Returns
<code>Some(true)</code> when the cookie was explicitly set (manually or parsed) as
<code>Secure</code>, <code>Some(false)</code> when <code>secure</code> was manually set to <code>false</code>, and
<code>None</code> otherwise.</p>
<h1 id="example-11" class="section-header"><a href="#example-11">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; Secure&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">None</span>);
<span class="comment">// An explicitly set &quot;false&quot; value.</span>
<span class="ident">c</span>.<span class="ident">set_secure</span>(<span class="bool-val">false</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">false</span>));
<span class="comment">// An explicitly set &quot;true&quot; value.</span>
<span class="ident">c</span>.<span class="ident">set_secure</span>(<span class="bool-val">true</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));</pre>
</div><h4 id='method.same_site' class="method"><span id='same_site.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.same_site' class='fnname'>same_site</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/cookie/0.11/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#459-461' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the <code>SameSite</code> attribute of this cookie if one was specified.</p>
<h1 id="example-12" class="section-header"><a href="#example-12">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::{<span class="ident">Cookie</span>, <span class="ident">SameSite</span>};
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; SameSite=Lax&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">same_site</span>(), <span class="prelude-val">Some</span>(<span class="ident">SameSite</span>::<span class="ident">Lax</span>));</pre>
</div><h4 id='method.max_age' class="method"><span id='max_age.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.max_age' class='fnname'>max_age</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/time/time/duration/struct.Duration.html" title="struct time::duration::Duration">Duration</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#477-479' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the specified max-age of the cookie if one was specified.</p>
<h1 id="example-13" class="section-header"><a href="#example-13">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">max_age</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; Max-Age=3600&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">max_age</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">age</span><span class="op">|</span> <span class="ident">age</span>.<span class="ident">num_hours</span>()), <span class="prelude-val">Some</span>(<span class="number">1</span>));</pre>
</div><h4 id='method.path' class="method"><span id='path.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.path' class='fnname'>path</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#498-503' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the <code>Path</code> of the cookie if one was specified.</p>
<h1 id="example-14" class="section-header"><a href="#example-14">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">path</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; Path=/&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">path</span>(), <span class="prelude-val">Some</span>(<span class="string">&quot;/&quot;</span>));
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; path=/sub&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">path</span>(), <span class="prelude-val">Some</span>(<span class="string">&quot;/sub&quot;</span>));</pre>
</div><h4 id='method.domain' class="method"><span id='domain.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.domain' class='fnname'>domain</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#519-524' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the <code>Domain</code> of the cookie if one was specified.</p>
<h1 id="example-15" class="section-header"><a href="#example-15">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">domain</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value; Domain=crates.io&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">domain</span>(), <span class="prelude-val">Some</span>(<span class="string">&quot;crates.io&quot;</span>));</pre>
</div><h4 id='method.expires' class="method"><span id='expires.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.expires' class='fnname'>expires</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/time/time/struct.Tm.html" title="struct time::Tm">Tm</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#542-544' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the <code>Expires</code> time of the cookie if one was specified.</p>
<h1 id="example-16" class="section-header"><a href="#example-16">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="string">&quot;name=value&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">expires</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="ident">expire_time</span> <span class="op">=</span> <span class="string">&quot;Wed, 21 Oct 2017 07:28:00 GMT&quot;</span>;
<span class="kw">let</span> <span class="ident">cookie_str</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;name=value; Expires={}&quot;</span>, <span class="ident">expire_time</span>);
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="ident">cookie_str</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">expires</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">t</span><span class="op">|</span> <span class="ident">t</span>.<span class="ident">tm_year</span>), <span class="prelude-val">Some</span>(<span class="number">117</span>));</pre>
</div><h4 id='method.set_name' class="method"><span id='set_name.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_name' class='fnname'>set_name</a>&lt;N&gt;(&amp;mut self, name: N) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#559-561' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the name of <code>self</code> to <code>name</code>.</p>
<h1 id="example-17" class="section-header"><a href="#example-17">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name</span>(), <span class="string">&quot;name&quot;</span>);
<span class="ident">c</span>.<span class="ident">set_name</span>(<span class="string">&quot;foo&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">name</span>(), <span class="string">&quot;foo&quot;</span>);</pre>
</div><h4 id='method.set_value' class="method"><span id='set_value.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_value' class='fnname'>set_value</a>&lt;V&gt;(&amp;mut self, value: V) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#576-578' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of <code>self</code> to <code>value</code>.</p>
<h1 id="example-18" class="section-header"><a href="#example-18">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">value</span>(), <span class="string">&quot;value&quot;</span>);
<span class="ident">c</span>.<span class="ident">set_value</span>(<span class="string">&quot;bar&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">value</span>(), <span class="string">&quot;bar&quot;</span>);</pre>
</div><h4 id='method.set_http_only' class="method"><span id='set_http_only.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_http_only' class='fnname'>set_http_only</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#594-596' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of <code>http_only</code> in <code>self</code> to <code>value</code>.</p>
<h1 id="example-19" class="section-header"><a href="#example-19">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">None</span>);
<span class="ident">c</span>.<span class="ident">set_http_only</span>(<span class="bool-val">true</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));</pre>
</div><h4 id='method.set_secure' class="method"><span id='set_secure.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_secure' class='fnname'>set_secure</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#612-614' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of <code>secure</code> in <code>self</code> to <code>value</code>.</p>
<h1 id="example-20" class="section-header"><a href="#example-20">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">None</span>);
<span class="ident">c</span>.<span class="ident">set_secure</span>(<span class="bool-val">true</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="prelude-val">Some</span>(<span class="bool-val">true</span>));</pre>
</div><h4 id='method.set_same_site' class="method"><span id='set_same_site.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_same_site' class='fnname'>set_same_site</a>(&amp;mut self, value: <a class="enum" href="https://docs.rs/cookie/0.11/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#630-632' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of <code>same_site</code> in <code>self</code> to <code>value</code>.</p>
<h1 id="example-21" class="section-header"><a href="#example-21">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::{<span class="ident">Cookie</span>, <span class="ident">SameSite</span>};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">same_site</span>().<span class="ident">is_none</span>());
<span class="ident">c</span>.<span class="ident">set_same_site</span>(<span class="ident">SameSite</span>::<span class="ident">Strict</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">same_site</span>(), <span class="prelude-val">Some</span>(<span class="ident">SameSite</span>::<span class="ident">Strict</span>));</pre>
</div><h4 id='method.set_max_age' class="method"><span id='set_max_age.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_max_age' class='fnname'>set_max_age</a>(&amp;mut self, value: <a class="struct" href="https://doc.rust-lang.org/time/time/duration/struct.Duration.html" title="struct time::duration::Duration">Duration</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#654-656' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the value of <code>max_age</code> in <code>self</code> to <code>value</code>.</p>
<h1 id="example-22" class="section-header"><a href="#example-22">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">time</span>;
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">use</span> <span class="ident">time</span>::<span class="ident">Duration</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">max_age</span>(), <span class="prelude-val">None</span>);
<span class="ident">c</span>.<span class="ident">set_max_age</span>(<span class="ident">Duration</span>::<span class="ident">hours</span>(<span class="number">10</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">max_age</span>(), <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">hours</span>(<span class="number">10</span>)));</pre>
</div><h4 id='method.set_path' class="method"><span id='set_path.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_path' class='fnname'>set_path</a>&lt;P&gt;(&amp;mut self, path: P) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#671-673' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>path</code> of <code>self</code> to <code>path</code>.</p>
<h1 id="example-23" class="section-header"><a href="#example-23">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">path</span>(), <span class="prelude-val">None</span>);
<span class="ident">c</span>.<span class="ident">set_path</span>(<span class="string">&quot;/&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">path</span>(), <span class="prelude-val">Some</span>(<span class="string">&quot;/&quot;</span>));</pre>
</div><h4 id='method.set_domain' class="method"><span id='set_domain.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_domain' class='fnname'>set_domain</a>&lt;D&gt;(&amp;mut self, domain: D) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#688-690' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>domain</code> of <code>self</code> to <code>domain</code>.</p>
<h1 id="example-24" class="section-header"><a href="#example-24">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">domain</span>(), <span class="prelude-val">None</span>);
<span class="ident">c</span>.<span class="ident">set_domain</span>(<span class="string">&quot;rust-lang.org&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">domain</span>(), <span class="prelude-val">Some</span>(<span class="string">&quot;rust-lang.org&quot;</span>));</pre>
</div><h4 id='method.set_expires' class="method"><span id='set_expires.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_expires' class='fnname'>set_expires</a>(&amp;mut self, time: <a class="struct" href="https://doc.rust-lang.org/time/time/struct.Tm.html" title="struct time::Tm">Tm</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#714-716' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the expires field of <code>self</code> to <code>time</code>.</p>
<h1 id="example-25" class="section-header"><a href="#example-25">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">time</span>;
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;name&quot;</span>, <span class="string">&quot;value&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">expires</span>(), <span class="prelude-val">None</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">now</span> <span class="op">=</span> <span class="ident">time</span>::<span class="ident">now</span>();
<span class="ident">now</span>.<span class="ident">tm_year</span> <span class="op">+=</span> <span class="number">1</span>;
<span class="ident">c</span>.<span class="ident">set_expires</span>(<span class="ident">now</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">expires</span>().<span class="ident">is_some</span>())</pre>
</div><h4 id='method.make_permanent' class="method"><span id='make_permanent.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.make_permanent' class='fnname'>make_permanent</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#740-744' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Makes <code>self</code> a &quot;permanent&quot; cookie by extending its expiration and max
age 20 years into the future.</p>
<h1 id="example-26" class="section-header"><a href="#example-26">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">time</span>;
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">use</span> <span class="ident">time</span>::<span class="ident">Duration</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">new</span>(<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">expires</span>().<span class="ident">is_none</span>());
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">max_age</span>().<span class="ident">is_none</span>());
<span class="ident">c</span>.<span class="ident">make_permanent</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">expires</span>().<span class="ident">is_some</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">max_age</span>(), <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">days</span>(<span class="number">365</span> <span class="op">*</span> <span class="number">20</span>)));</pre>
</div><h4 id='method.name_raw' class="method"><span id='name_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.name_raw' class='fnname'>name_raw</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'c <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#805-808' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the name of <code>self</code> as a string slice of the raw string <code>self</code>
was originally parsed from. If <code>self</code> was not originally parsed from a
raw string, returns <code>None</code>.</p>
<p>This method differs from <a href="#method.name">name</a> in that it returns a
string with the same lifetime as the originally parsed string. This
lifetime may outlive <code>self</code>. If a longer lifetime is not required, or
you're unsure if you need a longer lifetime, use <a href="#method.name">name</a>.</p>
<h1 id="example-27" class="section-header"><a href="#example-27">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie_string</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}={}&quot;</span>, <span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>);
<span class="comment">// `c` will be dropped at the end of the scope, but `name` will live on</span>
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> {
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="ident">cookie_string</span>.<span class="ident">as_str</span>()).<span class="ident">unwrap</span>();
<span class="ident">c</span>.<span class="ident">name_raw</span>()
};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">name</span>, <span class="prelude-val">Some</span>(<span class="string">&quot;foo&quot;</span>));</pre>
</div><h4 id='method.value_raw' class="method"><span id='value_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.value_raw' class='fnname'>value_raw</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'c <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#835-838' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the value of <code>self</code> as a string slice of the raw string <code>self</code>
was originally parsed from. If <code>self</code> was not originally parsed from a
raw string, returns <code>None</code>.</p>
<p>This method differs from <a href="#method.value">value</a> in that it returns a
string with the same lifetime as the originally parsed string. This
lifetime may outlive <code>self</code>. If a longer lifetime is not required, or
you're unsure if you need a longer lifetime, use <a href="#method.value">value</a>.</p>
<h1 id="example-28" class="section-header"><a href="#example-28">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie_string</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}={}&quot;</span>, <span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>);
<span class="comment">// `c` will be dropped at the end of the scope, but `value` will live on</span>
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> {
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="ident">cookie_string</span>.<span class="ident">as_str</span>()).<span class="ident">unwrap</span>();
<span class="ident">c</span>.<span class="ident">value_raw</span>()
};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value</span>, <span class="prelude-val">Some</span>(<span class="string">&quot;bar&quot;</span>));</pre>
</div><h4 id='method.path_raw' class="method"><span id='path_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.path_raw' class='fnname'>path_raw</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'c <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#866-871' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the <code>Path</code> of <code>self</code> as a string slice of the raw string <code>self</code>
was originally parsed from. If <code>self</code> was not originally parsed from a
raw string, or if <code>self</code> doesn't contain a <code>Path</code>, or if the <code>Path</code> has
changed since parsing, returns <code>None</code>.</p>
<p>This method differs from <a href="#method.path">path</a> in that it returns a
string with the same lifetime as the originally parsed string. This
lifetime may outlive <code>self</code>. If a longer lifetime is not required, or
you're unsure if you need a longer lifetime, use <a href="#method.path">path</a>.</p>
<h1 id="example-29" class="section-header"><a href="#example-29">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie_string</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}={}; Path=/&quot;</span>, <span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>);
<span class="comment">// `c` will be dropped at the end of the scope, but `path` will live on</span>
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> {
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="ident">cookie_string</span>.<span class="ident">as_str</span>()).<span class="ident">unwrap</span>();
<span class="ident">c</span>.<span class="ident">path_raw</span>()
};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">path</span>, <span class="prelude-val">Some</span>(<span class="string">&quot;/&quot;</span>));</pre>
</div><h4 id='method.domain_raw' class="method"><span id='domain_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.domain_raw' class='fnname'>domain_raw</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'c <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#900-905' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the <code>Domain</code> of <code>self</code> as a string slice of the raw string
<code>self</code> was originally parsed from. If <code>self</code> was not originally parsed
from a raw string, or if <code>self</code> doesn't contain a <code>Domain</code>, or if the
<code>Domain</code> has changed since parsing, returns <code>None</code>.</p>
<p>This method differs from <a href="#method.domain">domain</a> in that it returns a
string with the same lifetime as the originally parsed string. This
lifetime may outlive <code>self</code> struct. If a longer lifetime is not
required, or you're unsure if you need a longer lifetime, use
<a href="#method.domain">domain</a>.</p>
<h1 id="example-30" class="section-header"><a href="#example-30">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="ident">cookie_string</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}={}; Domain=crates.io&quot;</span>, <span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>);
<span class="comment">//`c` will be dropped at the end of the scope, but `domain` will live on</span>
<span class="kw">let</span> <span class="ident">domain</span> <span class="op">=</span> {
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">parse</span>(<span class="ident">cookie_string</span>.<span class="ident">as_str</span>()).<span class="ident">unwrap</span>();
<span class="ident">c</span>.<span class="ident">domain_raw</span>()
};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">domain</span>, <span class="prelude-val">Some</span>(<span class="string">&quot;crates.io&quot;</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-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'c&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#942-960' 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.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<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>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#956-959' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the cookie <code>self</code> as a <code>Set-Cookie</code> header value.</p>
<h1 id="example-31" class="section-header"><a href="#example-31">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cookie</span>::<span class="ident">Cookie</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cookie</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>)
.<span class="ident">path</span>(<span class="string">&quot;/&quot;</span>)
.<span class="ident">finish</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="ident">cookie</span>.<span class="ident">to_string</span>(), <span class="string">&quot;foo=bar; Path=/&quot;</span>);</pre>
</div></div><h3 id='impl-PartialEq%3CCookie%3C%27b%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a, 'b&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'b&gt;&gt; for <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'a&gt;</code><a href='#impl-PartialEq%3CCookie%3C%27b%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#970-997' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'b&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#971-996' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code><div class="docblock attributes">#[must_use]
</div>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Rhs) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'c&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#160' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#160' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-FromStr' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html" title="trait core::str::FromStr">FromStr</a> for <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'static&gt;</code><a href='#impl-FromStr' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#962-968' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Err' class="type"><span id='Err.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#associatedtype.Err' class="type">Err</a> = <a class="enum" href="../../actix_web/error/enum.CookieParseError.html" title="enum actix_web::error::CookieParseError">ParseError</a></code></span></h4>
<div class='docblock'><p>The associated error which can be returned from parsing.</p>
</div><h4 id='method.from_str' class="method"><span id='from_str.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#tymethod.from_str' class='fnname'>from_str</a>(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'static&gt;, <a class="enum" href="../../actix_web/error/enum.CookieParseError.html" title="enum actix_web::error::CookieParseError">ParseError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#965-967' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parses a string <code>s</code> to return a value of this type. <a href="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#tymethod.from_str">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'c&gt; <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="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</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/cookie/0.11/src/cookie/lib.rs.html#160' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' 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>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<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>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.11/src/cookie/lib.rs.html#160' 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&lt;'c&gt; <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="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</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&lt;'c&gt; <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="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a>&lt;'c&gt;</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>&#9166;</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>
Reference in New Issue View Git Blame Copy Permalink