<!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 middleware for session management in Actix Web applications."><metaname="keywords"content="rust, rustlang, rust-lang, SessionMiddleware"><title>SessionMiddleware 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">
<h1class="fqn"><spanclass="in-band">Struct <ahref="index.html">actix_session</a>::<wbr><aclass="struct"href="#">SessionMiddleware</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../clipboard.svg"width="19"height="18"alt="Copy item path"></button></span></h1><spanclass="out-of-band"><aclass="srclink"href="../src/actix_session/middleware.rs.html#111-114">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><divclass="docblock item-decl"><preclass="rust struct"><code>pub struct SessionMiddleware<Store: <aclass="trait"href="storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore">SessionStore</a>> { /* private fields */ }</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A middleware for session management in Actix Web applications.</p>
<p><ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a> takes care of a few jobs:</p>
<ul>
<li>Instructs the session storage backend to create/update/delete/retrieve the state attached to
a session according to its status and the operations that have been performed against it;</li>
<li>Set/remove a cookie, on the client side, to enable a user to be consistently associated with
the same session across multiple HTTP requests.</li>
</ul>
<p>Use <ahref="struct.SessionMiddleware.html#method.new"title="SessionMiddleware::new"><code>SessionMiddleware::new</code></a> to initialize the session framework using the default parameters.
To create a new instance of <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a> you need to provide:</p>
<ul>
<li>an instance of the session storage backend you wish to use (i.e. an implementation of
<p>If you want to customise use <ahref="struct.SessionMiddleware.html#method.builder"><code>builder</code></a> instead of <ahref="struct.SessionMiddleware.html#method.new"><code>new</code></a>:</p>
<h3id="how-did-we-choose-defaults"><ahref="#how-did-we-choose-defaults">How did we choose defaults?</a></h3>
<p>You should not regret adding <code>actix-session</code> to your dependencies and going to production using
the default configuration. That is why, when in doubt, we opt to use the most secure option for
each configuration parameter.</p>
<p>We expose knobs to change the default to suit your needs—i.e., if you know what you are doing,
we will not stop you. But being a subject-matter expert should not be a requirement to deploy
reasonably secure implementation of sessions.</p>
</div></details><h2id="implementations"class="small-section-header">Implementations<ahref="#implementations"class="anchor"></a></h2><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#224-251">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.SessionMiddleware.html"title="struct actix_session::SessionMiddleware">SessionMiddleware</a><Store></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.new"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#232-237">source</a></span><ahref="#method.new"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.new"class="fnname">new</a>(store: Store, key: <aclass="struct"href="https://docs.rs/cookie/0.16/cookie/secure/key/struct.Key.html"title="struct cookie::secure::key::Key">Key</a>) -> Self</h4></section></summary><divclass="docblock"><p>Use <ahref="struct.SessionMiddleware.html#method.new"title="SessionMiddleware::new"><code>SessionMiddleware::new</code></a> to initialize the session framework using the default
parameters.</p>
<p>To create a new instance of <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a> you need to provide:</p>
<ul>
<li>an instance of the session storage backend you wish to use (i.e. an implementation of
<li>a secret key, to sign or encrypt the content of client-side session cookie.</li>
</ul>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.builder"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#245-250">source</a></span><ahref="#method.builder"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.builder"class="fnname">builder</a>(store: Store, key: <aclass="struct"href="https://docs.rs/cookie/0.16/cookie/secure/key/struct.Key.html"title="struct cookie::secure::key::Key">Key</a>) -><aclass="struct"href="struct.SessionMiddlewareBuilder.html"title="struct actix_session::SessionMiddlewareBuilder">SessionMiddlewareBuilder</a><Store></h4></section></summary><divclass="docblock"><p>A fluent API to configure <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a>.</p>
<p>It takes as input the two required inputs to create a new instance of <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a>:</p>
<ul>
<li>an instance of the session storage backend you wish to use (i.e. an implementation of
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Transform%3CS%2C%20ServiceRequest%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_session/middleware.rs.html#368-388">source</a></span><ahref="#impl-Transform%3CS%2C%20ServiceRequest%3E"class="anchor"></a><h3class="code-header in-band">impl<S, B, Store> Transform<S, ServiceRequest> for <aclass="struct"href="struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware">SessionMiddleware</a><Store><spanclass="where fmt-newline">where<br> S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> B: MessageBody + 'static,<br> Store: <aclass="trait"href="storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore">SessionStore</a> + 'static, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Response"class="type trait-impl has-srclink"><ahref="#associatedtype.Response"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Response"class="associatedtype">Response</a> = ServiceResponse<B></h4></section></summary><divclass='docblock'><p>Responses produced by the service.</p>
</div></details><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="#associatedtype.Error"class="associatedtype">Error</a> = Error</h4></section></summary><divclass='docblock'><p>Errors produced by the service.</p>
</div></details><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Transform"class="type trait-impl has-srclink"><ahref="#associatedtype.Transform"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Transform"class="associatedtype">Transform</a> = InnerSessionMiddleware<S, Store></h4></section></summary><divclass='docblock'><p>The <code>TransformService</code> value created by this factory</p>
</div></details><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.InitError"class="type trait-impl has-srclink"><ahref="#associatedtype.InitError"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.InitError"class="associatedtype">InitError</a> = <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h4></section></summary><divclass='docblock'><p>Errors produced while building a transform service.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Instrument"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.31/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.31/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.31/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.31/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.31/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.31/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.31/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.31/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.31/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.31/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.31/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.31/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.to_owned"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89">source</a></span><ahref="#method.to_owned"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fnname">to_owned</a>(&self) -> T</h4></section></summary><divclass='docblock'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.clone_into"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#93">source</a></span><ahref="#method.clone_into"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fnname">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></section></summary><divclass="item-info"><divclass="stab unstable"><spanclass="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</div></div><divclass='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><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#594-603">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-2"class="type trait-impl has-srclink"><ahref="#associatedtype.Error-2"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></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><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#579-588">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.with_current_subscriber"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.31/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.31/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.31/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.31/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
