mirror of
https://github.com/actix/actix-website
synced 2024-11-28 18:32:39 +01:00
149 lines
31 KiB
HTML
149 lines
31 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 `CookieBuilder` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, CookieBuilder"><title>actix_web::http::CookieBuilder - 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">☰</div><p class='location'>Struct CookieBuilder</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.expires">expires</a><a href="#method.max_age">max_age</a><a href="#method.domain">domain</a><a href="#method.path">path</a><a href="#method.secure">secure</a><a href="#method.http_only">http_only</a><a href="#method.same_site">same_site</a><a href="#method.permanent">permanent</a><a href="#method.finish">finish</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</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: 'CookieBuilder', 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=''>CookieBuilder</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/cookie/0.10/src/cookie/builder.rs.html#35-38' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct CookieBuilder { /* fields omitted */ }</pre></div><div class='docblock'><p>Structure that follows the builder pattern for building <code>Cookie</code> structs.</p>
|
|||
|
<p>To construct a cookie:</p>
|
|||
|
<ol>
|
|||
|
<li>Call <a href="struct.Cookie.html#method.build"><code>Cookie::build</code></a> to start building.</li>
|
|||
|
<li>Use any of the builder methods to set fields in the cookie.</li>
|
|||
|
<li>Call <a href="#method.finish">finish</a> to retrieve the built cookie.</li>
|
|||
|
</ol>
|
|||
|
<h1 id="example" class="section-header"><a href="#example">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="ident">cookie</span>: <span class="ident">Cookie</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">"name"</span>, <span class="string">"value"</span>)
|
|||
|
.<span class="ident">domain</span>(<span class="string">"www.rust-lang.org"</span>)
|
|||
|
.<span class="ident">path</span>(<span class="string">"/"</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">max_age</span>(<span class="ident">Duration</span>::<span class="ident">days</span>(<span class="number">1</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.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></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.10/src/cookie/builder.rs.html#40-250' 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><N, V>(name: N, value: V) -> <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> N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#54-59' 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 name and value.</p>
|
|||
|
<p>This method is typically called indirectly via
|
|||
|
<a href="struct.Cookie.html#method.build">Cookie::build</a>.</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">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</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">"foo"</span>, <span class="string">"bar"</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>(self, when: <a class="struct" href="https://doc.rust-lang.org/time/time/struct.Tm.html" title="struct time::Tm">Tm</a>) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#80-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>expires</code> field in the cookie being built.</p>
|
|||
|
<h1 id="example-2" class="section-header"><a href="#example-2">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="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">expires</span>(<span class="ident">time</span>::<span class="ident">now</span>())
|
|||
|
.<span class="ident">finish</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.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>(self, value: <a class="struct" href="https://doc.rust-lang.org/time/time/duration/struct.Duration.html" title="struct time::duration::Duration">Duration</a>) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#105-108' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>max_age</code> field in the cookie being built.</p>
|
|||
|
<h1 id="example-3" class="section-header"><a href="#example-3">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">time</span>::<span class="ident">Duration</span>;
|
|||
|
|
|||
|
<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">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">max_age</span>(<span class="ident">Duration</span>::<span class="ident">minutes</span>(<span class="number">30</span>))
|
|||
|
.<span class="ident">finish</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">seconds</span>(<span class="number">30</span> <span class="op">*</span> <span class="number">60</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><D>(self, value: D) -> <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> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#123-126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>domain</code> field in the cookie being built.</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">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">domain</span>(<span class="string">"www.rust-lang.org"</span>)
|
|||
|
.<span class="ident">finish</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">"www.rust-lang.org"</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><P>(self, path: P) -> <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> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#141-144' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>path</code> field in the cookie being built.</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="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">path</span>(<span class="string">"/"</span>)
|
|||
|
.<span class="ident">finish</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">"/"</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>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#160-163' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>secure</code> field in the cookie being built.</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">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">secure</span>(<span class="bool-val">true</span>)
|
|||
|
.<span class="ident">finish</span>();
|
|||
|
|
|||
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">secure</span>(), <span class="bool-val">true</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>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#179-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>http_only</code> field in the cookie being built.</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">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">http_only</span>(<span class="bool-val">true</span>)
|
|||
|
.<span class="ident">finish</span>();
|
|||
|
|
|||
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">http_only</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>(self, value: <a class="enum" href="https://docs.rs/cookie/0.10/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#198-201' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <code>same_site</code> field in the cookie being built.</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="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">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">same_site</span>(<span class="ident">SameSite</span>::<span class="ident">Strict</span>)
|
|||
|
.<span class="ident">finish</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.permanent' class="method"><span id='permanent.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.permanent' class='fnname'>permanent</a>(self) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#225-228' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Makes the cookie being built 'permanent' by extending its expiration and
|
|||
|
max age 20 years into the future.</p>
|
|||
|
<h1 id="example-9" class="section-header"><a href="#example-9">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="ident">c</span> <span class="op">=</span> <span class="ident">Cookie</span>::<span class="ident">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">permanent</span>()
|
|||
|
.<span class="ident">finish</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.finish' class="method"><span id='finish.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.finish' class='fnname'>finish</a>(self) -> <a class="struct" href="../../actix_web/http/struct.Cookie.html" title="struct actix_web::http::Cookie">Cookie</a><'static></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#247-249' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Finishes building and returns the built <code>Cookie</code>.</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">build</span>(<span class="string">"foo"</span>, <span class="string">"bar"</span>)
|
|||
|
.<span class="ident">domain</span>(<span class="string">"crates.io"</span>)
|
|||
|
.<span class="ident">path</span>(<span class="string">"/"</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">"foo"</span>, <span class="string">"bar"</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">"crates.io"</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">"/"</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 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.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></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.10/src/cookie/builder.rs.html#34' 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/cookie/0.10/src/cookie/builder.rs.html#34' 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><h3 id='impl-Clone' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></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.10/src/cookie/builder.rs.html#34' 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>(&self) -> <a class="struct" href="../../actix_web/http/struct.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/cookie/0.10/src/cookie/builder.rs.html#34' 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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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></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 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.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></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 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.CookieBuilder.html" title="struct actix_web::http::CookieBuilder">CookieBuilder</a></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>
|