<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>Struct <ahref="../index.html">actix_session</a>::<wbr><ahref="index.html">storage</a>::<wbr><aclass="struct"href="#">RedisActorSessionStore</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/storage/redis_actor.rs.html#56-59">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct RedisActorSessionStore { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Use Redis as session storage backend.</p>
Redis. Use <ahref="struct.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore"><code>RedisSessionStore</code></a> if you need TLS support.</p>
) -><aclass="struct"href="struct.RedisActorSessionStoreBuilder.html"title="struct actix_session::storage::RedisActorSessionStoreBuilder">RedisActorSessionStoreBuilder</a></h4></section></summary><divclass="docblock"><p>A fluent API to configure <ahref="struct.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.new"class="method"><aclass="src rightside"href="../../src/actix_session/storage/redis_actor.rs.html#76-78">source</a><h4class="code-header">pub fn <ahref="#method.new"class="fn">new</a><S: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>>(connection_string: S) -><aclass="struct"href="struct.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h4></section></summary><divclass="docblock"><p>Create a new instance of <ahref="struct.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a> using the default configuration.
It takes as input the only required input to create a new instance of <ahref="struct.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a> - a
'life1: 'async_trait,</div></h4></section></summary><divclass='docblock'>Loads the session state associated to a session key.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.save"class="method trait-impl"><aclass="src rightside"href="../../src/actix_session/storage/redis_actor.rs.html#149-188">source</a><ahref="#method.save"class="anchor">§</a><h4class="code-header">fn <ahref="trait.SessionStore.html#tymethod.save"class="fn">save</a><'life0, 'life1, 'async_trait>(
'life1: 'async_trait,</div></h4></section></summary><divclass='docblock'>Persist the session state for a newly created session. <ahref="trait.SessionStore.html#tymethod.save">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.update"class="method trait-impl"><aclass="src rightside"href="../../src/actix_session/storage/redis_actor.rs.html#190-238">source</a><ahref="#method.update"class="anchor">§</a><h4class="code-header">fn <ahref="trait.SessionStore.html#tymethod.update"class="fn">update</a><'life0, 'life1, 'async_trait>(
'life1: 'async_trait,</div></h4></section></summary><divclass='docblock'>Updates the session state associated to a pre-existing session key.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.update_ttl"class="method trait-impl"><aclass="src rightside"href="../../src/actix_session/storage/redis_actor.rs.html#240-256">source</a><ahref="#method.update_ttl"class="anchor">§</a><h4class="code-header">fn <ahref="trait.SessionStore.html#tymethod.update_ttl"class="fn">update_ttl</a><'life0, 'life1, 'life2, 'async_trait>(
'life2: 'async_trait,</div></h4></section></summary><divclass='docblock'>Updates the TTL of the session state associated to a pre-existing session key.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.delete"class="method trait-impl"><aclass="src rightside"href="../../src/actix_session/storage/redis_actor.rs.html#258-274">source</a><ahref="#method.delete"class="anchor">§</a><h4class="code-header">fn <ahref="trait.SessionStore.html#tymethod.delete"class="fn">delete</a><'life0, 'life1, 'async_trait>(
'life1: 'async_trait,</div></h4></section></summary><divclass='docblock'>Deletes a session from the store.</div></details></div></details></div><h2id="synthetic-implementations"class="section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor">§</a></h2><divid="synthetic-implementations-list"><sectionid="impl-RefUnwindSafe-for-RedisActorSessionStore"class="impl"><ahref="#impl-RefUnwindSafe-for-RedisActorSessionStore"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.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><sectionid="impl-Send-for-RedisActorSessionStore"class="impl"><ahref="#impl-Send-for-RedisActorSessionStore"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.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><sectionid="impl-Sync-for-RedisActorSessionStore"class="impl"><ahref="#impl-Sync-for-RedisActorSessionStore"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.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><sectionid="impl-Unpin-for-RedisActorSessionStore"class="impl"><ahref="#impl-Unpin-for-RedisActorSessionStore"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.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><sectionid="impl-UnwindSafe-for-RedisActorSessionStore"class="impl"><ahref="#impl-UnwindSafe-for-RedisActorSessionStore"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</a> for <aclass="struct"href="struct.RedisActorSessionStore.html"title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section></div><h2id="blanket-implementations"class="section-header">Blanket Implementations<ahref="#blanket-implementations"class="anchor">§</a></h2><divid="blanket-implementations-list"><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Any-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#140">source</a><ahref="#impl-Any-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T<divclass="where">where
T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.type_id"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><ahref="#method.type_id"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id"class="fn">type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></h4></section></summary><divclass='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Borrow%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><ahref="#impl-Borrow%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T<divclass="where">where
T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.borrow"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><ahref="#method.borrow"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow"class="fn">borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a></h4></section></summary><divclass='docblock'>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-BorrowMut%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><ahref="#impl-BorrowMut%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<divclass="where">where
T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.borrow_mut"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><ahref="#method.borrow_mut"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut"class="fn">borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a></h4></section></summary><divclass='docblock'>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-From%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#763">source</a><ahref="#impl-From%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a><ahref="#method.from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from"class="fn">from</a>(t: T) -> T</h4></section></summary><divclass="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-T"class="impl"><ahref="#impl-Instrument-for-T"class="anchor">§</a><h3class="code-header">impl<T> Instrument for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl"><ahref="#method.instrument"class="anchor">§</a><h4class="code-header">fn <aclass="fn">instrument</a>(self, span: Span) -> Instrumented<Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl"><ahref="#method.in_current_span"class="anchor">§</a><h4class="code-header">fn <aclass="fn">in_current_span</a>(self) -> Instrumented<Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="super::Span::current()">current</a><ahref="crate::Span"><code>Span</code></a>, returning an
<code><ahref="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><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="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'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#810">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">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="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'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#788-790">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">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<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"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'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#795">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">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="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'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-VZip%3CV%3E-for-T"class="impl"><ahref="#impl-VZip%3CV%3E-for-T"class="anchor">§</a><h3class="code-header">impl<V, T> VZip<V> for T<divclass="where">where
S: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><Dispatch>,</div></h4></section></summary><divclass='docblock'>Attaches the provided <ahref="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl"><ahref="#method.with_current_subscriber"class="anchor">§</a><h4class="code-header">fn <aclass="fn">with_current_subscriber</a>(self) -> WithDispatch<Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="crate::dispatcher#setting-the-default-subscriber">default</a><ahref="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
