<!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="Use Redis as session storage backend."><metaname="keywords"content="rust, rustlang, rust-lang, RedisSessionStore"><title>RedisSessionStore in actix_session::storage - 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-f2fc7b5fd698d27d.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../../static.files/light-5f7299aa2b503fb1.css"><linkrel="stylesheet"disabledhref="../../static.files/dark-dfb18ef8114bb428.css"><linkrel="stylesheet"disabledhref="../../static.files/ayu-4047a6aaddd3789d.css"><scriptid="default-settings"></script><scriptsrc="../../static.files/storage-d43fa987303ecbbb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-02cbe07fc548e88c.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="#">RedisSessionStore</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block"><li><ahref="#method.builder">builder</a></li><li><ahref="#method.new">new</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-Clone-for-RedisSessionStore">Clone</a></li><li><ahref="#impl-SessionStore-for-RedisSessionStore">SessionStore</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-RedisSessionStore">!RefUnwindSafe</a></li><li><ahref="#impl-Send-for-RedisSessionStore">Send</a></li><li><ahref="#impl-Sync-for-RedisSessionStore">Sync</a></li><li><ahref="#impl-Unpin-for-RedisSessionStore">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-RedisSessionStore">!UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block"><li><ahref="#impl-Any-for-RedisSessionStore">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-RedisSessionStore">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-RedisSessionStore">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-RedisSessionStore">From<T></a></li><li><ahref="#impl-Instrument-for-RedisSessionStore">Instrument</a></li><li><ahref="#impl-Into%3CU%3E-for-RedisSessionStore">Into<U></a></li><li><ahref="#impl-Same%3CT%3E-for-RedisSessionStore">Same<T></a></li><li><ahref="#impl-ToOwned-for-RedisSessionStore">ToOwned</a></li><li><ahref="#impl-TryFrom%3CU%3E-for-RedisSessionStore">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E-for-RedisSessionStore">TryInto<U></a></li><li><ahref="#impl-VZip%3CV%3E-for-RedisSessionStore">VZip<V></a></li><li><ahref="#impl-WithSubscriber-for-RedisSessionStore">WithSubscriber</a></li></ul></section><h2><ahref="index.html">In actix_session::storage</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"><h1>Struct <ahref="../index.html">actix_session</a>::<wbr><ahref="index.html">storage</a>::<wbr><aclass="struct"href="#">RedisSessionStore</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="srclink"href="../../src/actix_session/storage/redis_rs.rs.html#65-68">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><divclass="item-decl"><preclass="rust"><code>pub struct RedisSessionStore { /* private fields */ }</code></pre></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Use Redis as session storage backend.</p>
It takes as input the only required input to create a new instance of <ahref="struct.RedisSessionStore.html"title="RedisSessionStore"><code>RedisSessionStore</code></a> - a
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.new"class="method"><aclass="srclink rightside"href="../../src/actix_session/storage/redis_rs.rs.html#97-101">source</a><h4class="code-header">pub async 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>>>(<br> connection_string: S<br>) -><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.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</a>, <aclass="struct"href="https://docs.rs/anyhow/1.0.68/anyhow/struct.Error.html"title="struct anyhow::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Create a new instance of <ahref="struct.RedisSessionStore.html"title="RedisSessionStore"><code>RedisSessionStore</code></a> using the default configuration.
It takes as input the only required input to create a new instance of <ahref="struct.RedisSessionStore.html"title="RedisSessionStore"><code>RedisSessionStore</code></a> - a
</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="toggle implementors-toggle"open><summary><sectionid="impl-Clone-for-RedisSessionStore"class="impl"><aclass="srclink rightside"href="../../src/actix_session/storage/redis_rs.rs.html#64">source</a><ahref="#impl-Clone-for-RedisSessionStore"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.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</a></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.clone"class="method trait-impl"><aclass="srclink rightside"href="../../src/actix_session/storage/redis_rs.rs.html#64">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.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</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="toggle method-toggle"open><summary><sectionid="method.clone_from"class="method trait-impl"><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">&Self</a>)</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="toggle implementors-toggle"open><summary><sectionid="impl-SessionStore-for-RedisSessionStore"class="impl"><aclass="srclink rightside"href="../../src/actix_session/storage/redis_rs.rs.html#138-250">source</a><ahref="#impl-SessionStore-for-RedisSessionStore"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="trait.SessionStore.html"title="trait actix_session::storage::SessionStore">SessionStore</a> for <aclass="struct"href="struct.RedisSessionStore.html"title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</a></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.load"class="method trait-impl"><aclass="srclink rightside"href="../../src/actix_session/storage/redis_rs.rs.html#139-154">source</a><ahref="#method.load"class="anchor">§</a><h4class="code-header">fn <ahref="trait.SessionStore.html#tymethod.load"class="fn">load</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <aclass="struct"href="struct.SessionKey.html"title="struct actix_session::storage::SessionKey">SessionKey</a><br>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html"title="struct core::pin::Pin">Pin</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"title="trait core::future::future::Future">Future</a><Output = <a
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-RedisSessionStore"class="impl"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><ahref="#impl-Instrument-for-RedisSessionStore"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="toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl"><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="toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl"><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
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Same%3CT%3E-for-RedisSessionStore"class="impl"><aclass="srclink rightside"href="https://docs.rs/typenum/1.16.0/src/typenum/type_operators.rs.html#34">source</a><ahref="#impl-Same%3CT%3E-for-RedisSessionStore"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://docs.rs/typenum/1.16.0/typenum/type_operators/trait.Same.html"title="trait typenum::type_operators::Same">Same</a><T> for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Output"class="associatedtype trait-impl"><ahref="#associatedtype.Output"class="anchor">§</a><h4class="code-header">type <ahref="https://docs.rs/typenum/1.16.0/typenum/type_operators/trait.Same.html#associatedtype.Output"class="associatedtype">Output</a> = T</h4></section></summary><divclass='docblock'>Should always be <code>Self</code></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-ToOwned-for-RedisSessionStore"class="impl"><aclass="srclink rightside"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#82">source</a><ahref="#impl-ToOwned-for-RedisSessionStore"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T<spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Owned"class="associatedtype trait-impl"><ahref="#associatedtype.Owned"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="associatedtype">Owned</a> = T</h4></section></summary><divclass='docblock'>The resulting type after obtaining ownership.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.to_owned"class="method trait-impl"><aclass="srclink rightside"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#87">source</a><ahref="#method.to_owned"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fn">to_owned</a>(&self) -> T</h4></section></summary><divclass='docblock'>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.clone_into"class="method trait-impl"><aclass="srclink rightside"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#91">source</a><ahref="#method.clone_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a>)</h4></section></summary><divclass='docblock'>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-RedisSessionStore"class="impl"><aclass="srclink rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><ahref="#impl-TryFrom%3CU%3E-for-RedisSessionStore"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="traitcore::convert::
<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="toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl"><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
