<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `CookieBuilder` struct in crate `actix_web`."><metaname="keywords"content="rust, rustlang, rust-lang, CookieBuilder"><title>actix_web::http::CookieBuilder - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><pclass='location'>Struct CookieBuilder</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.new">new</a><ahref="#method.expires">expires</a><ahref="#method.max_age">max_age</a><ahref="#method.domain">domain</a><ahref="#method.path">path</a><ahref="#method.secure">secure</a><ahref="#method.http_only">http_only</a><ahref="#method.same_site">same_site</a><ahref="#method.permanent">permanent</a><ahref="#method.finish">finish</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a></div></div><pclass='location'><ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>http</a></p><script>window.sidebarCurrent={name:'CookieBuilder',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><inputclass="search-input"name="search"autocomplete="off"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><aid="settings-menu"href="../../settings.html"><imgsrc="../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='in-band'>Struct <ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>http</a>::<wbr><aclass="struct"href=''>CookieBuilder</a></span><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#35-38'title='goto source code'>[src]</a></span></h1><divclass="docblock type-decl"><preclass='rust struct'>pub struct CookieBuilder { /* fields omitted */ }</pre></div><divclass='docblock'><p>Structure that follows the builder pattern for building <code>Cookie</code> structs.</p>
<h3id='impl'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl <aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code><ahref='#impl'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#40-250'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.new'class="method"><spanid='new.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.new'class='fnname'>new</a><N, V>(name: N, value: V) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a><spanclass="where fmt-newline">where<br> N: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'static, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>,<br> V: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'static, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, </span></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#54-59'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Creates a new <code>CookieBuilder</code> instance from the given name and value.</p>
</div><h4id='method.expires'class="method"><spanid='expires.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.expires'class='fnname'>expires</a>(self, when: <aclass="struct"href="https://doc.rust-lang.org/time/time/struct.Tm.html"title="struct time::Tm">Tm</a>) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#80-83'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>expires</code> field in the cookie being built.</p>
</div><h4id='method.max_age'class="method"><spanid='max_age.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.max_age'class='fnname'>max_age</a>(self, value: <aclass="struct"href="https://doc.rust-lang.org/time/time/duration/struct.Duration.html"title="struct time::duration::Duration">Duration</a>) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#105-108'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>max_age</code> field in the cookie being built.</p>
</div><h4id='method.domain'class="method"><spanid='domain.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.domain'class='fnname'>domain</a><D>(self, value: D) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a><spanclass="where fmt-newline">where<br> D: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'static, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, </span></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#123-126'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>domain</code> field in the cookie being built.</p>
</div><h4id='method.path'class="method"><spanid='path.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.path'class='fnname'>path</a><P>(self, path: P) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a><spanclass="where fmt-newline">where<br> P: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html"title="enum alloc::borrow::Cow">Cow</a><'static, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, </span></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#141-144'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>path</code> field in the cookie being built.</p>
</div><h4id='method.secure'class="method"><spanid='secure.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.secure'class='fnname'>secure</a>(self, value: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#160-163'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>secure</code> field in the cookie being built.</p>
</div><h4id='method.http_only'class="method"><spanid='http_only.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.http_only'class='fnname'>http_only</a>(self, value: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#179-182'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>http_only</code> field in the cookie being built.</p>
</div><h4id='method.same_site'class="method"><spanid='same_site.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.same_site'class='fnname'>same_site</a>(self, value: <aclass="enum"href="https://docs.rs/cookie/0.11/cookie/draft/enum.SameSite.html"title="enum cookie::draft::SameSite">SameSite</a>) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#198-201'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets the <code>same_site</code> field in the cookie being built.</p>
</div><h4id='method.permanent'class="method"><spanid='permanent.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.permanent'class='fnname'>permanent</a>(self) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#225-228'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Makes the cookie being built 'permanent' by extending its expiration and
</div><h4id='method.finish'class="method"><spanid='finish.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.finish'class='fnname'>finish</a>(self) -><aclass="struct"href="../../actix_web/http/struct.Cookie.html"title="struct actix_web::http::Cookie">Cookie</a><'static></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#247-249'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Finishes building and returns the built <code>Cookie</code>.</p>
<divid='implementations-list'><h3id='impl-Clone'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> for <aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code><ahref='#impl-Clone'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#34'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.clone'class="method"><spanid='clone.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone'class='fnname'>clone</a>(&self) -><aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#34'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Returns a copy of the value. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div></div><h3id='impl-Debug'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code><ahref='#impl-Debug'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#34'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.fmt'class="method"><spanid='fmt.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html"title="struct core::fmt::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://docs.rs/cookie/0.11/src/cookie/builder.rs.html#34'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a>
</h2>
<divid='synthetic-implementations-list'>
<h3id='impl-Send'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code><ahref='#impl-Send'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div><h3id='impl-Sync'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="../../actix_web/http/struct.CookieBuilder.html"title="struct actix_web::http::CookieBuilder">CookieBuilder</a></code><ahref='#impl-Sync'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
