<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../actix_session/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="../index.html">actix_session</a>::<wbr><ahref="index.html">config</a>::<wbr><aclass="struct"href="#">SessionMiddlewareBuilder</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/actix_session/config.rs.html#215-218">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct SessionMiddlewareBuilder<Store: <aclass="trait"href="../storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore">SessionStore</a>> { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A fluent, customized <ahref="../struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware"><code>SessionMiddleware</code></a> builder.</p>
</div></details><h2id="implementations"class="section-header">Implementations<ahref="#implementations"class="anchor">§</a></h2><divid="implementations-list"><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-SessionMiddlewareBuilder%3CStore%3E"class="impl"><aclass="src rightside"href="../../src/actix_session/config.rs.html#220-352">source</a><ahref="#impl-SessionMiddlewareBuilder%3CStore%3E"class="anchor">§</a><h3class="code-header">impl<Store: <aclass="trait"href="../storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore">SessionStore</a>><aclass="struct"href="struct.SessionMiddlewareBuilder.html"title="struct actix_session::config::SessionMiddlewareBuilder">SessionMiddlewareBuilder</a><Store></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.cookie_name"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#231-234">source</a><h4class="code-header">pub fn <ahref="#method.cookie_name"class="fn">cookie_name</a>(self, name: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>) -> Self</h4></section></summary><divclass="docblock"><p>Set the name of the cookie used to store the session ID.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.cookie_secure"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#242-245">source</a><h4class="code-header">pub fn <ahref="#method.cookie_secure"class="fn">cookie_secure</a>(self, secure: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Set the <code>Secure</code> attribute for the cookie used to store the session ID.</p>
) -> Self</h4></section></summary><divclass="docblock"><p>Determines what type of session cookie should be used and how its lifecycle should be managed.
Check out <ahref="enum.SessionLifecycle.html"title="enum actix_session::config::SessionLifecycle"><code>SessionLifecycle</code></a>’s documentation for more details on the available options.</p>
<p>Default is <ahref="enum.SessionLifecycle.html#variant.BrowserSession"title="variant actix_session::config::SessionLifecycle::BrowserSession"><code>SessionLifecycle::BrowserSession</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.cookie_same_site"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#293-296">source</a><h4class="code-header">pub fn <ahref="#method.cookie_same_site"class="fn">cookie_same_site</a>(self, same_site: <aclass="enum"href="https://docs.rs/cookie/0.16/cookie/draft/enum.SameSite.html"title="enum cookie::draft::SameSite">SameSite</a>) -> Self</h4></section></summary><divclass="docblock"><p>Set the <code>SameSite</code> attribute for the cookie used to store the session ID.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.cookie_path"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#301-304">source</a><h4class="code-header">pub fn <ahref="#method.cookie_path"class="fn">cookie_path</a>(self, path: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>) -> Self</h4></section></summary><divclass="docblock"><p>Set the <code>Path</code> attribute for the cookie used to store the session ID.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.cookie_domain"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#312-315">source</a><h4class="code-header">pub fn <ahref="#method.cookie_domain"class="fn">cookie_domain</a>(self, domain: <aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Set the <code>Domain</code> attribute for the cookie used to store the session ID.</p>
key by accident, regardless of <ahref="../storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore"><code>SessionStore</code></a> implementation you chose to use.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.cookie_http_only"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#342-345">source</a><h4class="code-header">pub fn <ahref="#method.cookie_http_only"class="fn">cookie_http_only</a>(self, http_only: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Set the <code>HttpOnly</code> attribute for the cookie used to store the session ID.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.build"class="method"><aclass="src rightside"href="../../src/actix_session/config.rs.html#349-351">source</a><h4class="code-header">pub fn <ahref="#method.build"class="fn">build</a>(self) -><aclass="struct"href="../struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware">SessionMiddleware</a><Store></h4></section></summary><divclass="docblock"><p>Finalise the builder and return a <ahref="../struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware"><code>SessionMiddleware</code></a> instance.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-T"class="impl"><ahref="#impl-Instrument-for-T"class="anchor">§</a><h3class="code-header">impl<T> Instrument for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl"><ahref="#method.instrument"class="anchor">§</a><h4class="code-header">fn <aclass="fn">instrument</a>(self, span: Span) -> Instrumented<Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl"><ahref="#method.in_current_span"class="anchor">§</a><h4class="code-header">fn <aclass="fn">in_current_span</a>(self) -> Instrumented<Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="super::Span::current()">current</a><ahref="crate::Span"><code>Span</code></a>, returning an
<code><ahref="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#789-791">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-VZip%3CV%3E-for-T"class="impl"><ahref="#impl-VZip%3CV%3E-for-T"class="anchor">§</a><h3class="code-header">impl<V, T> VZip<V> for T<divclass="where">where
S: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><Dispatch>,</div></h4></section></summary><divclass='docblock'>Attaches the provided <ahref="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl"><ahref="#method.with_current_subscriber"class="anchor">§</a><h4class="code-header">fn <aclass="fn">with_current_subscriber</a>(self) -> WithDispatch<Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="crate::dispatcher#setting-the-default-subscriber">default</a><ahref="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
