<!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="API documentation for the Rust `RedisSession` struct in crate `actix_redis`."><metaname="keywords"content="rust, rustlang, rust-lang, RedisSession"><title>actix_redis::RedisSession - Rust</title><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><scriptsrc="../storage.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="shortcut icon"href="../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../actix_redis/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct RedisSession</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#implementations">Methods</a><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><aclass="sidebar-title"href="#trait-implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Transform%3CS%3E">Transform<S></a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><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><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><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></div></div><pclass='location'><ahref='index.html'>actix_redis</a></p><script>window.sidebarCurrent={name:'RedisSession',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../theme.js"></script><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><spanclass="help-button">?</span>
<aid="settings-menu"href="../settings.html"><imgsrc="../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><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_redis/session.rs.html#28'title='goto source code'>[src]</a></span><spanclass='in-band'>Struct <ahref='index.html'>actix_redis</a>::<wbr><aclass="struct"href=''>RedisSession</a></span></h1><divclass="docblock type-decl hidden-by-usual-hider"><preclass='rust struct'>pub struct RedisSession(_);</pre></div><divclass='docblock'><p>Use redis as session storage.</p>
</div><h4id='method.ttl'class="method"><code>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</code><aclass='srclink'href='../src/actix_redis/session.rs.html#51-54'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Set time to live in seconds for session value</p>
</div><h4id='method.cookie_name'class="method"><code>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</code><aclass='srclink'href='../src/actix_redis/session.rs.html#57-60'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Set custom cookie name for session id</p>
</div></div><h2id='trait-implementations'class='small-section-header'>Trait Implementations<ahref='#trait-implementations'class='anchor'></a></h2><divid='trait-implementations-list'><h3id='impl-Transform%3CS%3E'class='impl'><codeclass='in-band'>impl<S, B> Transform<S> for <aclass="struct"href="../actix_redis/struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a><spanclass="where fmt-newline">where<br> S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> B: 'static, </span></code><ahref='#impl-Transform%3CS%3E'class='anchor'></a><aclass='srclink'href='../src/actix_redis/session.rs.html#107-127'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Request'class="type"><code>type <ahref='#associatedtype.Request'class="type">Request</a> = ServiceRequest</code></h4><divclass='docblock'><p>Requests handled by the service.</p>
</div><h4id='associatedtype.Response'class="type"><code>type <ahref='#associatedtype.Response'class="type">Response</a> = ServiceResponse<B></code></h4><divclass='docblock'><p>Responses given by the service.</p>
</div><h4id='associatedtype.Error'class="type"><code>type <ahref='#associatedtype.Error'class="type">Error</a> = S::Error</code></h4><divclass='docblock'><p>Errors produced by the service.</p>
</div><h4id='associatedtype.InitError'class="type"><code>type <ahref='#associatedtype.InitError'class="type">InitError</a> = <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><divclass='docblock'><p>Errors produced while building a transform service.</p>
</div><h4id='associatedtype.Transform'class="type"><code>type <ahref='#associatedtype.Transform'class="type">Transform</a> = RedisSessionMiddleware<S></code></h4><divclass='docblock'><p>The <code>TransformService</code> value created by this factory</p>
</div><h4id='method.new_transform'class="method hidden"><code>fn <ahref='#method.new_transform'class='fnname'>new_transform</a>(&self, service: S) -> Self::Future</code><aclass='srclink'href='../src/actix_redis/session.rs.html#121-126'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
</div><h4id='method.map_init_err'class="method hidden"><code>fn <ahref='#method.map_init_err'class='fnname'>map_init_err</a><F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E><spanclass="where fmt-newline">where<br> F: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html"title="trait core::ops::function::Fn">Fn</a>(Self::InitError) -> E + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></code></h4><divclass='docblock hidden'><p>Map this transforms's factory error to a different error, returning a new transform service factory. <ahref="#method.map_init_err">Read more</a></p>
</div></div></div><h2id='synthetic-implementations'class='small-section-header'>Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a></h2><divid='synthetic-implementations-list'><h3id='impl-RefUnwindSafe'class='impl'><codeclass='in-band'>impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html"title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="../actix_redis/struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a></code><ahref='#impl-RefUnwindSafe'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-Send'class='impl'><codeclass='in-band'>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="../actix_redis/struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a></code><ahref='#impl-Send'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-Sync'class='impl'><codeclass='in-band'>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="../actix_redis/struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a></code><ahref='#impl-Sync'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-Unpin'class='impl'><codeclass='in-band'>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="../actix_redis/struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a></code><ahref='#impl-Unpin'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-UnwindSafe'class='impl'><codeclass='in-band'>impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html"title="trait std::panic::UnwindSafe">UnwindSafe</a> for <aclass="struct"href="../actix_redis/struct.RedisSession.html"title="struct actix_redis::RedisSession">RedisSession</a></code><ahref='#impl-UnwindSafe'class='anchor'></a></h3><divclass='impl-items'></div></div><h2id='blanket-implementations'class='small-section-header'>Blanket Implementations<ahref='#blanket-implementations'class='anchor'></a></h2><divid='blanket-implementations-list'><h3id='impl-Any'class='impl'><codeclass='in-band'>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 <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><code>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>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></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>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></p>
</div></div><h3id='impl-Instrument'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html"title="trait tracing_futures::Instrument">Instrument</a> for T</code><ahref='#impl-Instrument'class='anchor'></a><aclass='srclink'href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#248'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.instrument'class="method hidden"><code>fn <ahref='https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.instrument'class='fnname'>instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/struct.Instrumented.html"title="struct tracing_futures::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#129-131'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4id='method.in_current_span'class="method hidden"><code>fn <ahref='https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.in_current_span'class='fnname'>in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/struct.Instrumented.html"title="struct tracing_futures::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#166-168'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3id='impl-Instrument-1'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</code><ahref='#impl-Instrument-1'class='anchor'></a><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#155'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.instrument-1'class="method hidden"><code>fn <ahref='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument'class='fnname'>instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#38-40'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4id='method.in_current_span-1'class="method hidden"><code>fn <ahref='https://docs.rs/tracing/0.1.21/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.21/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#74-76'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3id='impl-Same%3CT%3E'class='impl'><codeclass='in-band'>impl<T> Same<T> for T</code><ahref='#impl-Same%3CT%3E'class='anchor'></a></h3><divclass='impl-items'><h4id='associatedtype.Output'class="type"><code>type <ahref='#associatedtype.Output'class="type">Output</a> = T</code></h4><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='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></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#607-616'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><code>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></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><code>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>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#613-615'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='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></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#593-602'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-2'class="type"><code>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></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><code>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>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#599-601'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
