<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>Crate <aclass="mod"href="#">actix_session</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/lib.rs.html#1-732">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Session management for Actix Web.</p>
top of Actix Web. <ahref="struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware"><code>SessionMiddleware</code></a> is the middleware underpinning the functionality
<ahref="storage/struct.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore"><code>RedisSessionStore</code></a>, and <ahref="storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a>) - you can create a custom storage backend
by implementing the <ahref="storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore"><code>SessionStore</code></a> trait.</p>
<p>To start using sessions in your Actix Web application you must register <ahref="struct.SessionMiddleware.html"title="struct actix_session::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="struct actix_session::Session"><code>Session</code></a>
<p>a purely cookie-based “backend”, <ahref="storage/struct.CookieSessionStore.html"title="struct actix_session::storage::CookieSessionStore"><code>CookieSessionStore</code></a>, using the <code>cookie-session</code> feature
<p>a Redis-based backend via <ahref="https://docs.rs/redis-rs"><code>redis-rs</code></a>, <ahref="storage/struct.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore"><code>RedisSessionStore</code></a>, using
<p>You can implement your own session storage backend using the <ahref="storage/trait.SessionStore.html"title="trait actix_session::storage::SessionStore"><code>SessionStore</code></a> trait.</p>
</div></details><h2id="modules"class="section-header">Modules<ahref="#modules"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="config/index.html"title="mod actix_session::config">config</a></div><divclass="desc docblock-short">Configuration options to tune the behaviour of <ahref="struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware"><code>SessionMiddleware</code></a>.</div></li><li><divclass="item-name"><aclass="mod"href="storage/index.html"title="mod actix_session::storage">storage</a></div><divclass="desc docblock-short">Pluggable storage backends for session state.</div></li></ul><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></div><divclass="desc docblock-short">The primary interface to access and modify session state.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SessionGetError.html"title="struct actix_session::SessionGetError">SessionGetError</a></div><divclass="desc docblock-short">Error returned by <ahref="struct.Session.html#method.get"title="method actix_session::Session::get"><code>Session::get</code></a>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SessionInsertError.html"title="struct actix_session::SessionInsertError">SessionInsertError</a></div><divclass="desc docblock-short">Error returned by <ahref="struct.Session.html#method.insert"title="method actix_session::Session::insert"><code>Session::insert</code></a>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SessionMiddleware.html"title="struct actix_session::SessionMiddleware">SessionMiddleware</a></div><divclass="desc docblock-short">A middleware for session management in Actix Web applications.</div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.SessionStatus.html"title="enum actix_session::SessionStatus">SessionStatus</a></div><divclass="desc docblock-short">Status of a <ahref="struct.Session.html"title="struct actix_session::Session"><code>Session</code></a>.</div></li></ul><h2id="traits"class="section-header">Traits<ahref="#traits"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="trait"href="trait.SessionExt.html"title="trait actix_session::SessionExt">SessionExt</a></div><divclass="desc docblock-short">Extract a <ahref="struct.Session.html"title="struct actix_session::Session"><code>Session</code></a> object from various <code>actix-web</code> types (e.g. <code>HttpRequest</code>,
