<!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 high-level interface you use to modify session data."><metaname="keywords"content="rust, rustlang, rust-lang, Session"><title>Session 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="alternate icon"type="image/png"href="../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../favicon.svg"></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="sidebar"><divclass="sidebar-menu"role="button">☰</div><aclass="sidebar-logo"href="../actix_session/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.png"alt="logo"></div>
</a><h2class="location">Struct Session</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.clear">clear</a><ahref="#method.entries">entries</a><ahref="#method.get">get</a><ahref="#method.get_changes">get_changes</a><ahref="#method.insert">insert</a><ahref="#method.purge">purge</a><ahref="#method.remove">remove</a><ahref="#method.remove_as">remove_as</a><ahref="#method.renew">renew</a><ahref="#method.set_session">set_session</a></div><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-FromRequest">FromRequest</a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">!RefUnwindSafe</a><ahref="#impl-Send">!Send</a><ahref="#impl-Sync">!Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">!UnwindSafe</a></div><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Instrument">Instrument</a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a><ahref="#impl-VZip%3CV%3E">VZip<V></a><ahref="#impl-WithSubscriber">WithSubscriber</a></div></div><h2class="location">Other items in<br><ahref="index.html">actix_session</a></h2><divid="sidebar-vars"data-name="Session"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../actix_session/index.html"><imgclass="rust-logo"src="../rust-logo.png"alt="logo"></a><navclass="sub"><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="18"height="18"alt="Pick another theme!"src="../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgwidth="18"height="18"alt="Change settings"src="../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><h1class="fqn"><spanclass="in-band">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="../clipboard.svg"width="19"height="18"alt="Copy item path"></button></span><spanclass="out-of-band"><spanid="render-detail"><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span><aclass="srclink"href="../src/actix_session/lib.rs.html#84"title="goto source code">[src]</a></span></h1><divclass="docblock 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 high-level interface you use to modify session data.</p>
<p>Session object is obtained with <ahref="trait.UserSession.html#tymethod.get_session"title="UserSession::get_session"><code>UserSession::get_session</code></a>. The <ahref="trait.UserSession.html"title="UserSession"><code>UserSession</code></a> trait is
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.entries"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_session/lib.rs.html#154-156"title="goto source code">[src]</a></div><ahref="#method.entries"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.entries"class="fnname">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></div></summary><divclass="docblock"><p>Get all raw key-value data from the session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.clear"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_session/lib.rs.html#208-215"title="goto source code">[src]</a></div><ahref="#method.clear"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.clear"class="fnname">clear</a>(&self)</h4></div></summary><divclass="docblock"><p>Clear the session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.purge"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_session/lib.rs.html#218-222"title="goto source code">[src]</a></div><ahref="#method.purge"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.purge"class="fnname">purge</a>(&self)</h4></div></summary><divclass="docblock"><p>Removes session both client and server side.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.renew"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_session/lib.rs.html#225-231"title="goto source code">[src]</a></div><ahref="#method.renew"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.renew"class="fnname">renew</a>(&self)</h4></div></summary><divclass="docblock"><p>Renews the session key, assigning existing session state to new key.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.set_session"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_session/lib.rs.html#249-253"title="goto source code">[src]</a></div><ahref="#method.set_session"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.set_session"class="fnname">set_session</a>(<br> req: &mut ServiceRequest, <br> data: impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html"title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>><br>)</h4></div></summary><divclass="docblock"><p>Adds the given key-value pairs to the session on the request.</p>
</div><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Error"class="type">Error</a> = Error</h4></div></summary><divclass='docblock'><p>The associated error which can be returned.</p>
</div></details><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Future"class="type trait-impl has-srclink"><ahref="#associatedtype.Future"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Future"class="type">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></div></summary><divclass='docblock'><p>Future that resolves to a Self.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-Instrument"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#276"title="goto source code">[src]</a></div><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.29/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.instrument"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#82"title="goto source code">[src]</a></div><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.29/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></div></summary><divclass='docblock'><p>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.in_current_span"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#121"title="goto source code">[src]</a></div><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/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.29/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></div></summary><divclass='docblock'><p>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588-597"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="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.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#594"title="goto source code">[src]</a></div><ahref="#method.try_from"class="anchor"></a><h4class="code-header">pub 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="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574-583"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="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.TryInto.html#associatedtype.Error"class="type">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="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#580"title="goto source code">[src]</a></div><ahref="#method.try_into"class="anchor"></a><h4class="code-header">pub 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="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.with_current_subscriber"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#221"title="goto source code">[src]</a></div><ahref="#method.with_current_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/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.29/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></div></summary><divclass='docblock'><p>Attaches the current <ahref="https://docs.rs/tracing/0.1.29/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.21/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
