<!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="A fluent builder to construct a [`SessionMiddleware`] instance with custom configuration parameters."><metaname="keywords"content="rust, rustlang, rust-lang, SessionMiddlewareBuilder"><title>SessionMiddlewareBuilder in actix_session - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptsrc="../crates.js"></script><scriptdefersrc="../main.js"></script>
<noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="icon"href="https://actix.rs/favicon.ico"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../actix_session/index.html"><divclass="logo-container"><imgsrc="https://actix.rs/img/logo.png"alt="logo"></div>
<imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
</div></details><h2id="implementations"class="small-section-header">Implementations<ahref="#implementations"class="anchor"></a></h2><divid="implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#265-370">source</a></span><ahref="#impl"class="anchor"></a><h3class="code-header in-band">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::SessionMiddlewareBuilder">SessionMiddlewareBuilder</a><Store></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_name"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#269-272">source</a></span><ahref="#method.cookie_name"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_name"class="fnname">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="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_secure"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#280-283">source</a></span><ahref="#method.cookie_secure"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_secure"class="fnname">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>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.session_length"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#289-303">source</a></span><ahref="#method.session_length"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.session_length"class="fnname">session_length</a>(self, session_length: <aclass="enum"href="enum.SessionLength.html"title="enum actix_session::SessionLength">SessionLength</a>) -> Self</h4></section></summary><divclass="docblock"><p>Determine how long a session should last - check out <ahref="enum.SessionLength.html"title="SessionLength"><code>SessionLength</code></a>’s documentation for
<p>Default is <ahref="enum.SessionLength.html#variant.BrowserSession"title="SessionLength::BrowserSession"><code>SessionLength::BrowserSession</code></a>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_same_site"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#308-311">source</a></span><ahref="#method.cookie_same_site"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_same_site"class="fnname">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="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_path"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#316-319">source</a></span><ahref="#method.cookie_path"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_path"class="fnname">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="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_domain"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#327-330">source</a></span><ahref="#method.cookie_domain"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_domain"class="fnname">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>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_content_security"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#346-349">source</a></span><ahref="#method.cookie_content_security"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_content_security"class="fnname">cookie_content_security</a>(<br> self, <br> content_security: <aclass="enum"href="enum.CookieContentSecurity.html"title="enum actix_session::CookieContentSecurity">CookieContentSecurity</a><br>) -> Self</h4></section></summary><divclass="docblock"><p>Choose how the session cookie content should be secured.</p>
<li><ahref="enum.CookieContentSecurity.html#variant.Signed"title="CookieContentSecurity::Signed"><code>CookieContentSecurity::Signed</code></a> selects signed cookie content.</li>
<p>By default, the cookie content is encrypted. Encrypted was chosen instead of signed as
default because it reduces the chances of sensitive information being exposed in the session
key by accident, regardless of <ahref="storage/trait.SessionStore.html"title="SessionStore"><code>SessionStore</code></a> implementation you chose to use.</p>
<p>For example, if you are using cookie-based storage, you definitely want the cookie content
to be encrypted—the whole session state is embedded in the cookie! If you are using
Redis-based storage, signed is more than enough - the cookie content is just a unique
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.cookie_http_only"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#357-360">source</a></span><ahref="#method.cookie_http_only"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_http_only"class="fnname">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="rustdoc-toggle method-toggle"open><summary><sectionid="method.build"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#364-369">source</a></span><ahref="#method.build"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.build"class="fnname">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="SessionMiddleware"><code>SessionMiddleware</code></a> instance.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.32/src/tracing/instrument.rs.html#276">source</a></span><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.32/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.32/src/tracing/instrument.rs.html#82">source</a></span><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.32/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.32/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.32/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.32/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.32/src/tracing/instrument.rs.html#121">source</a></span><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.32/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.32/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.32/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.32/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#598-607">source</a></span><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="type trait-impl has-srclink"><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'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#604">source</a></span><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="fnname">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'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#583-592">source</a></span><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">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 <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="type trait-impl has-srclink"><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'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589">source</a></span><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="fnname">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'><p>Performs the conversion.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.32/src/tracing/instrument.rs.html#221">source</a></span><ahref="#method.with_current_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.32/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fnname">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.32/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'><p>Attaches the current <ahref="https://docs.rs/tracing/0.1.32/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
