<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_redis/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">Struct RedisSession</a></h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.cache_keygen">cache_keygen</a><ahref="#method.cookie_domain">cookie_domain</a><ahref="#method.cookie_http_only">cookie_http_only</a><ahref="#method.cookie_max_age">cookie_max_age</a><ahref="#method.cookie_name">cookie_name</a><ahref="#method.cookie_path">cookie_path</a><ahref="#method.cookie_same_site">cookie_same_site</a><ahref="#method.cookie_secure">cookie_secure</a><ahref="#method.new">new</a><ahref="#method.ttl">ttl</a></div><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Transform%3CS%2C%20ServiceRequest%3E">Transform<S, ServiceRequest></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_redis</a></h2><divid="sidebar-vars"data-name="RedisSession"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_redis/index.html"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><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>
<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"><divclass="main-heading">
<h1class="fqn"><spanclass="in-band">Struct <ahref="index.html">actix_redis</a>::<wbr><aclass="struct"href="#">RedisSession</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></h1><spanclass="out-of-band"><aclass="srclink"href="../src/actix_redis/session.rs.html#27"title="goto source code">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><divclass="docblock item-decl"><preclass="rust struct"><code>pub struct RedisSession(_);</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Use redis as session storage.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.ttl"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/session.rs.html#50-53"title="goto source code">source</a></div><ahref="#method.ttl"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.ttl"class="fnname">ttl</a>(self, ttl: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> Self</h4></div></summary><divclass="docblock"><p>Set time to live in seconds for session value.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.cookie_name"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/session.rs.html#56-59"title="goto source code">source</a></div><ahref="#method.cookie_name"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.cookie_name"class="fnname">cookie_name</a>(self, name: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</h4></div></summary><divclass="docblock"><p>Set custom cookie name for session ID.</p>
</div></details></div></details><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><divid="impl-Transform%3CS%2C%20ServiceRequest%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/session.rs.html#115-136"title="goto source code">source</a></div><ahref="#impl-Transform%3CS%2C%20ServiceRequest%3E"class="anchor"></a><h3class="code-header in-band">impl<S, B> Transform<S, ServiceRequest> for <aclass="struct"href="struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a><spanclass="where fmt-newline">where<br> S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> B: 'static, </span></h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Response"class="type trait-impl has-srclink"><ahref="#associatedtype.Response"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Response"class="associatedtype">Response</a> = ServiceResponse<B></h4></div></summary><divclass='docblock'><p>Responses produced by the service.</p>
</div></details><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="associatedtype">Error</a> = S::Error</h4></div></summary><divclass='docblock'><p>Errors produced by the service.</p>
</div></details><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Transform"class="type trait-impl has-srclink"><ahref="#associatedtype.Transform"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Transform"class="associatedtype">Transform</a> = RedisSessionMiddleware<S></h4></div></summary><divclass='docblock'><p>The <code>TransformService</code> value created by this factory</p>
</div></details><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.InitError"class="type trait-impl has-srclink"><ahref="#associatedtype.InitError"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.InitError"class="associatedtype">InitError</a> = <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h4></div></summary><divclass='docblock'><p>Errors produced while building a transform service.</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">source</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">source</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">source</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-Into%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#537-544"title="goto source code">source</a></div><ahref="#impl-Into%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.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.into"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#541"title="goto source code">source</a></div><ahref="#method.into"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into"class="fnname">into</a>(self) -> U</h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-Same%3CT%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/typenum/1.15.0/src/typenum/type_operators.rs.html#34-36"title="goto source code">source</a></div><ahref="#impl-Same%3CT%3E"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html"title="trait typenum::type_operators::Same">Same</a><T> for T</h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Output"class="type trait-impl has-srclink"><ahref="#associatedtype.Output"class="anchor"></a><h4class="code-header">type <ahref="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html#associatedtype.Output"class="associatedtype">Output</a> = T</h4></div></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</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#589-598"title="goto source code">source</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="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></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#595"title="goto source code">source</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="associatedtype"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">source</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="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></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">source</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="associatedtype"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-VZip%3CV%3E"class="impl has-srclink"><divclass="rightside"></div><ahref="#impl-VZip%3CV%3E"class="anchor"></a><h3class="code-header in-band">impl<V, T> VZip<V> for T <spanclass="where fmt-newline">where<br> V: MultiLane<T>, </span></h3></div></summary><divclass="impl-items"><divid="method.vzip"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.vzip"class="anchor"></a><h4class="code-header">pub fn <aclass="fnname">vzip</a>(self) -> V</h4></div></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-WithSubscriber"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#334"title="goto source code">source</a></div><ahref="#impl-WithSubscriber"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.29/tracing/instrument/trait.WithSubscriber.html"title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.with_subscriber"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#169-171"title="goto source code">source</a></div><ahref="#method.with_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber"class="fnname">with_subscriber</a><S>(self, subscriber: S) -><aclass="struct"href="https://docs.rs/tracing/0.1.29/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><spanclass="where fmt-newline">where<br> 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://docs.rs/tracing-core/0.1.21/tracing_core/dispatcher/struct.Dispatch.html"title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>, </span></h4></div></summary><divclass='docblock'><p>Attaches the provided <ahref="https://docs.rs/tracing-core/0.1.21/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
</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">source</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
