<!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="The primary interface to access and modify session state."><metaname="keywords"content="rust, rustlang, rust-lang, Session"><title>Session in actix_session - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-04897efae0a76fcd.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../static.files/light-4743e13df3dfe8c4.css"><linkrel="stylesheet"disabledhref="../static.files/dark-0e1b889528bd466b.css"><linkrel="stylesheet"disabledhref="../static.files/ayu-65289d5d067c7c66.css"><scriptid="default-settings"></script><scriptsrc="../static.files/storage-d43fa987303ecbbb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-bc1b32400f872ddb.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-13285aec31fa243e.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="logo-container"href="../actix_session/index.html"><imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><h2></h2></nav><navclass="sidebar"><aclass="logo-container"href="../actix_session/index.html">
<imgsrc="https://actix.rs/img/logo.png"alt="logo"></a><h2class="location"><ahref="#">Session</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block"><li><ahref="#method.clear">clear</a></li><li><ahref="#method.entries">entries</a></li><li><ahref="#method.get">get</a></li><li><ahref="#method.insert">insert</a></li><li><ahref="#method.purge">purge</a></li><li><ahref="#method.remove">remove</a></li><li><ahref="#method.remove_as">remove_as</a></li><li><ahref="#method.renew">renew</a></li><li><ahref="#method.status">status</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-Clone-for-Session">Clone</a></li><li><ahref="#impl-FromRequest-for-Session">FromRequest</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-Session">!RefUnwindSafe</a></li><li><ahref="#impl-Send-for-Session">!Send</a></li><li><ahref="#impl-Sync-for-Session">!Sync</a></li><li><ahref="#impl-Unpin-for-Session">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-Session">!UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block"><li><ahref="#impl-Any-for-Session">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-Session">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-Session">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-Session">From<T></a></li><li><ahref="#impl-Instrument-for-Session">Instrument</a></li><li><ahref="#impl-Into%3CU%3E-for-Session">Into<U></a></li><li><ahref="#impl-Same%3CT%3E-for-Session">Same<T></a></li><li><ahref="#impl-ToOwned-for-Session">ToOwned</a></li><li><ahref="#impl-TryFrom%3CU%3E-for-Session">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E-for-Session">TryInto<U></a></li><li><ahref="#impl-VZip%3CV%3E-for-Session">VZip<V></a></li><li><ahref="#impl-WithSubscriber-for-Session">WithSubscriber</a></li></ul></section><h2><ahref="index.html">In actix_session</a></h2></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><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"title="help"tabindex="-1"><ahref="../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1class="fqn">Struct <ahref="index.html">actix_session</a>::<wbr><aclass="struct"href="#">Session</a><buttonid="copy-path"onclick="copy_path(this)"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="srclink"href="../src/actix_session/session.rs.html#46">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><divclass="item-decl"><preclass="rust struct"><code>pub struct Session(_);</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>The primary interface to access and modify session state.</p>
<p><ahref="struct.Session.html"title="Session"><code>Session</code></a> is an <ahref="#impl-FromRequest">extractor</a>—you can specify it as an input type for your
request handlers and it will be automatically extracted from the incoming request.</p>
<p>You can also retrieve a <ahref="struct.Session.html"title="Session"><code>Session</code></a> object from an <code>HttpRequest</code> or a <code>ServiceRequest</code> using
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.entries"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#108-110">source</a><h4class="code-header">pub fn <ahref="#method.entries"class="fn">entries</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html"title="struct core::cell::Ref">Ref</a><'_, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html"title="struct std::collections::hash::map::HashMap">HashMap</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>></h4></section></summary><divclass="docblock"><p>Get all raw key-value data from the session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.remove"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#156-167">source</a><h4class="code-header">pub fn <ahref="#method.remove"class="fn">remove</a>(&self, key: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -><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>></h4></section></summary><divclass="docblock"><p>Remove value from the session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.remove_as"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#173-187">source</a><h4class="code-header">pub fn <ahref="#method.remove_as"class="fn">remove_as</a><T: <aclass="trait"href="https://docs.rs/serde/1.0.152/serde/de/trait.DeserializeOwned.html"title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(<br> &self,<br> key: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>></h4></section></summary><divclass="docblock"><p>Remove value from the session and deserialize.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.clear"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#190-199">source</a><h4class="code-header">pub fn <ahref="#method.clear"class="fn">clear</a>(&self)</h4></section></summary><divclass="docblock"><p>Clear the session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.purge"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#202-206">source</a><h4class="code-header">pub fn <ahref="#method.purge"class="fn">purge</a>(&self)</h4></section></summary><divclass="docblock"><p>Removes session both client and server side.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.renew"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#209-215">source</a><h4class="code-header">pub fn <ahref="#method.renew"class="fn">renew</a>(&self)</h4></section></summary><divclass="docblock"><p>Renews the session key, assigning existing session state to new key.</p>
</div></details></div></details></div><h2id="trait-implementations"class="small-section-header">Trait Implementations<ahref="#trait-implementations"class="anchor">§</a></h2><divid="trait-implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Clone-for-Session"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#45">source</a><ahref="#impl-Clone-for-Session"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> for <aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.clone"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#45">source</a><ahref="#method.clone"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone"class="fn">clone</a>(&self) -><aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h4></section></summary><divclass='docblock'>Returns a copy of the value. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.clone_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="Stable since Rust version 1.0.0">1.0.0</span> · <aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#132-134">source</a></span><ahref="#method.clone_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from"class="fn">clone_from</a>(&mut self, source: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><divclass='docblock'>Performs copy-assignment from <code>source</code>. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-FromRequest-for-Session"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#282-290">source</a><ahref="#impl-FromRequest-for-Session"class="anchor">§</a><h3class="code-header">impl FromRequest for <aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h3></section></summary><divclass="docblock"><p>Extractor implementation for <ahref="struct.Session.html"title="Session"><code>Session</code></a>s.</p>
</div><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <aclass="associatedtype">Error</a> = Error</h4></section></summary><divclass='docblock'>The associated error which can be returned.</div></details><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Future"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Future"class="anchor">§</a><h4class="code-header">type <aclass="associatedtype">Future</a> = Ready<<aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a>, Error>></h4></section></summary><divclass='docblock'>Future that resolves to a <code>Self</code>. <a>Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from_request"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/actix_session/session.rs.html#287-289">source</a><ahref="#method.from_request"class="anchor">§</a><h4class="code-header">fn <aclass="fn">from_request</a>(req: &HttpRequest, _: &mut Payload) -> Self::Future</h4></section></summary><divclass='docblock'>Create a <code>Self</code> from request parts asynchronously.</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.extract"class="method trait-impl has-srclink"><ahref="#method.extract"class="anchor">§</a><h4class="code-header">fn <aclass="fn">extract</a>(req: &HttpRequest) -> Self::Future</h4></section></summary><divclass='docblock'>Create a <code>Self</code> from request head asynchronously. <a>Read more</a></div></details></div></details></div><h2id="synthetic-implementations"class="small-section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor">§</a></h2><divid="synthetic-implementations-list"><sectionid="impl-RefUnwindSafe-for-Session"class="impl has-srclink"><ahref="#impl-RefUnwindSafe-for-Session"class="anchor">§</a><h3class="code-header">impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html"title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h3></section><sectionid="impl-Send-for-Session"class="impl has-srclink"><ahref="#impl-Send-for-Session"class="anchor">§</a><h3class="code-header">impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h3></section><sectionid="impl-Sync-for-Session"class="impl has-srclink"><ahref="#impl-Sync-for-Session"class="anchor">§</a><h3class="code-header">impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h3></section><sectionid="impl-Unpin-for-Session"class="impl has-srclink"><ahref="#impl-Unpin-for-Session"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a> for <aclass="struct"href="struct.Session.html"title="struct actix_session::Session">Session</a></h3></section><sectionid="impl-UnwindSafe-for-Session"class="impl has-srclink"><ahref="#impl-UnwindSafe-for-Session"class="anchor">§</a><h3class="code-header">impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html"title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe<
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-Session"class="impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><ahref="#impl-Instrument-for-Session"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.37/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"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><ahref="#method.instrument"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument"class="fn">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><ahref="#method.in_current_span"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fn">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="WithDispatch"><code>WithDispatch</code></a> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><ahref="#method.with_current_subscriber"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fn">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="https://docs.rs/tracing/0.1.37/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
