<!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="Session management for Actix Web."><metaname="keywords"content="rust, rustlang, rust-lang, actix_session"><title>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"href="../normalize.css"><linkrel="stylesheet"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"href="../ayu.css"disabled><linkrel="stylesheet"href="../dark.css"disabled><linkrel="stylesheet"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptdefersrc="../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 mod crate"><!--[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></a><h2class="location"></h2></nav><navclass="sidebar"><aclass="sidebar-logo"href="../actix_session/index.html"><divclass="logo-container">
<imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><navclass="sub"><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"><divid="help-button"title="help"tabindex="-1"><buttontype="button">?</button></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../wheel.svg"></a></div></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading"><h1class="fqn"><spanclass="in-band">Crate <aclass="mod"href="#">actix_session</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/lib.rs.html#1-732">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Session management for Actix Web.</p>
<p>There is a solution - <strong>sessions</strong>. Using sessions the server can attach state to a set of
requests coming from the same client. They are built on top of cookies - the server sets a
cookie in the HTTP response (<code>Set-Cookie</code> header), the client (e.g. the browser) will store the
cookie and play it back to the server when sending new requests (using the <code>Cookie</code> header).</p>
<p>We refer to the cookie used for sessions as a <strong>session cookie</strong>. Its content is called
<strong>session key</strong> (or <strong>session ID</strong>), while the state attached to the session is referred to as
<strong>session state</strong>.</p>
<p><code>actix-session</code> provides an easy-to-use framework to manage sessions in applications built on
top of Actix Web. <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a> is the middleware underpinning the functionality
provided by <code>actix-session</code>; it takes care of all the session cookie handling and instructs the
<strong>storage backend</strong> to create/delete/update the session state based on the operations performed
against the active <ahref="struct.Session.html"title="Session"><code>Session</code></a>.</p>
<p><code>actix-session</code> provides some built-in storage backends: (<ahref="storage/struct.CookieSessionStore.html"><code>CookieSessionStore</code></a>,
<ahref="storage/struct.RedisSessionStore.html"><code>RedisSessionStore</code></a>, and <ahref="storage/struct.RedisActorSessionStore.html"><code>RedisActorSessionStore</code></a>) - you can create a custom storage backend
by implementing the <ahref="storage/trait.SessionStore.html"><code>SessionStore</code></a> trait.</p>
<p>To start using sessions in your Actix Web application you must register <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a>
<p>The session state can be accessed and modified by your request handlers using the <ahref="struct.Session.html"title="Session"><code>Session</code></a>
<p>a purely cookie-based “backend”, <ahref="storage/struct.CookieSessionStore.html"><code>CookieSessionStore</code></a>, using the <code>cookie-session</code> feature
actix-session = { version = "...", features = ["cookie-session"] }</code></pre></div></li>
<li>
<p>a Redis-based backend via <ahref="https://docs.rs/acitx-redis"><code>actix-redis</code></a>,
<ahref="storage/struct.RedisActorSessionStore.html"><code>RedisActorSessionStore</code></a>, using the <code>redis-actor-session</code> feature flag.</p>
actix-session = { version = "...", features = ["redis-actor-session"] }</code></pre></div></li>
<li>
<p>a Redis-based backend via <ahref="https://docs.rs/redis-rs"><code>redis-rs</code></a>, <ahref="storage/struct.RedisSessionStore.html"><code>RedisSessionStore</code></a>, using
the <code>redis-rs-session</code> feature flag.</p>
</div></details><h2id="modules"class="small-section-header"><ahref="#modules">Modules</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="config/index.html"title="actix_session::config mod">config</a></div><divclass="item-right docblock-short"><p>Configuration options to tune the behaviour of <ahref="struct.SessionMiddleware.html"title="SessionMiddleware"><code>SessionMiddleware</code></a>.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.SessionGetError.html"title="actix_session::SessionGetError struct">SessionGetError</a></div><divclass="item-right docblock-short"><p>Error returned by <ahref="struct.Session.html#method.get"title="Session::get"><code>Session::get</code></a>.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.SessionInsertError.html"title="actix_session::SessionInsertError struct">SessionInsertError</a></div><divclass="item-right docblock-short"><p>Error returned by <ahref="struct.Session.html#method.insert"title="Session::insert"><code>Session::insert</code></a>.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.SessionMiddleware.html"title="actix_session::SessionMiddleware struct">SessionMiddleware</a></div><divclass="item-right docblock-short"><p>A middleware for session management in Actix Web applications.</p>
</div></div></div><h2id="enums"class="small-section-header"><ahref="#enums">Enums</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="enum"href="enum.SessionStatus.html"title="actix_session::SessionStatus enum">SessionStatus</a></div><divclass="item-right docblock-short"><p>Status of a <ahref="struct.Session.html"title="Session"><code>Session</code></a>.</p>
</div></div></div><h2id="traits"class="small-section-header"><ahref="#traits">Traits</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="trait"href="trait.SessionExt.html"title="actix_session::SessionExt trait">SessionExt</a></div><divclass="item-right docblock-short"><p>Extract a <ahref="struct.Session.html"title="Session"><code>Session</code></a> object from various <code>actix-web</code> types (e.g. <code>HttpRequest</code>,
