mirror of
https://github.com/actix/actix-extras.git
synced 2025-08-20 07:15:41 +02:00
Deploying to gh-pages from @ 5a72dd33d5 🚀
This commit is contained in:
robjtede
@@ -6,29 +6,32 @@
|
||||
constructor of <code>RedisSession</code>. This is private key for cookie
|
||||
session, When this value is changed, all session data is lost.</p>
|
||||
<p>Constructor panics if key length is less than 32 bytes.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_redis/session.rs.html#30-106" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(addr: S, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a class="srclink" href="../src/actix_redis/session.rs.html#34-48" title="goto source code">[src]</a></h4><div class="docblock"><p>Create new redis session backend</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_redis/session.rs.html#30-114" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(addr: S, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a class="srclink" href="../src/actix_redis/session.rs.html#34-48" title="goto source code">[src]</a></h4><div class="docblock"><p>Create new redis session backend</p>
|
||||
<ul>
|
||||
<li><code>addr</code> - address of the redis server</li>
|
||||
</ul>
|
||||
</div><h4 id="method.ttl" class="method"><code>pub fn <a href="#method.ttl" class="fnname">ttl</a>(self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#51-54" title="goto source code">[src]</a></h4><div class="docblock"><p>Set time to live in seconds for session value</p>
|
||||
</div><h4 id="method.cookie_name" class="method"><code>pub fn <a href="#method.cookie_name" class="fnname">cookie_name</a>(self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#57-60" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie name for session id</p>
|
||||
</div><h4 id="method.cookie_path" class="method"><code>pub fn <a href="#method.cookie_path" class="fnname">cookie_path</a>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#63-66" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie path</p>
|
||||
</div><h4 id="method.cookie_domain" class="method"><code>pub fn <a href="#method.cookie_domain" class="fnname">cookie_domain</a>(self, domain: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#69-72" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie domain</p>
|
||||
</div><h4 id="method.cookie_secure" class="method"><code>pub fn <a href="#method.cookie_secure" class="fnname">cookie_secure</a>(self, secure: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#77-80" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie secure
|
||||
If the <code>secure</code> field is set, a cookie will only be transmitted when the
|
||||
connection is secure - i.e. <code>https</code></p>
|
||||
</div><h4 id="method.cookie_max_age" class="method"><code>pub fn <a href="#method.cookie_max_age" class="fnname">cookie_max_age</a>(self, max_age: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Duration>>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#84-87" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie max-age
|
||||
Use <code>None</code> for session-only cookies</p>
|
||||
</div><h4 id="method.cookie_same_site" class="method"><code>pub fn <a href="#method.cookie_same_site" class="fnname">cookie_same_site</a>(self, same_site: <a class="enum" href="../actix_redis/enum.SameSite.html" title="enum actix_redis::SameSite">SameSite</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#90-93" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie SameSite</p>
|
||||
</div><h4 id="method.cookie_http_only" class="method"><code>pub fn <a href="#method.cookie_http_only" class="fnname">cookie_http_only</a>(self, http_only: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#96-99" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie HttpOnly policy</p>
|
||||
</div><h4 id="method.cache_keygen" class="method"><code>pub fn <a href="#method.cache_keygen" class="fnname">cache_keygen</a>(self, keygen: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#102-105" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a custom cache key generation strategy, expecting session key as input</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Transform%3CS%3E" class="impl"><code class="in-band">impl<S, B> Transform<S> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a> <span class="where fmt-newline">where<br> S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> B: 'static, </span></code><a href="#impl-Transform%3CS%3E" class="anchor"></a><a class="srclink" href="../src/actix_redis/session.rs.html#108-128" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Request" class="type"><code>type <a href="#associatedtype.Request" class="type">Request</a> = ServiceRequest</code></h4><div class='docblock'><p>Requests handled by the service.</p>
|
||||
</div><h4 id="method.ttl" class="method"><code>pub fn <a href="#method.ttl" class="fnname">ttl</a>(self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#51-54" title="goto source code">[src]</a></h4><div class="docblock"><p>Set time to live in seconds for session value.</p>
|
||||
</div><h4 id="method.cookie_name" class="method"><code>pub fn <a href="#method.cookie_name" class="fnname">cookie_name</a>(self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#57-60" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie name for session ID.</p>
|
||||
</div><h4 id="method.cookie_path" class="method"><code>pub fn <a href="#method.cookie_path" class="fnname">cookie_path</a>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#63-66" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie path.</p>
|
||||
</div><h4 id="method.cookie_domain" class="method"><code>pub fn <a href="#method.cookie_domain" class="fnname">cookie_domain</a>(self, domain: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#69-72" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie domain.</p>
|
||||
</div><h4 id="method.cookie_secure" class="method"><code>pub fn <a href="#method.cookie_secure" class="fnname">cookie_secure</a>(self, secure: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#80-83" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie secure.</p>
|
||||
<p>If the <code>secure</code> field is set, a cookie will only be transmitted when the
|
||||
connection is secure - i.e. <code>https</code>.</p>
|
||||
<p>Default is false.</p>
|
||||
</div><h4 id="method.cookie_max_age" class="method"><code>pub fn <a href="#method.cookie_max_age" class="fnname">cookie_max_age</a>(self, max_age: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Duration>>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#88-91" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie max-age.</p>
|
||||
<p>Use <code>None</code> for session-only cookies.</p>
|
||||
</div><h4 id="method.cookie_same_site" class="method"><code>pub fn <a href="#method.cookie_same_site" class="fnname">cookie_same_site</a>(self, same_site: <a class="enum" href="../actix_redis/enum.SameSite.html" title="enum actix_redis::SameSite">SameSite</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#96-99" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie <code>SameSite</code> attribute.</p>
|
||||
<p>By default, the attribute is omitted.</p>
|
||||
</div><h4 id="method.cookie_http_only" class="method"><code>pub fn <a href="#method.cookie_http_only" class="fnname">cookie_http_only</a>(self, http_only: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#104-107" title="goto source code">[src]</a></h4><div class="docblock"><p>Set custom cookie <code>HttpOnly</code> policy.</p>
|
||||
<p>Default is true.</p>
|
||||
</div><h4 id="method.cache_keygen" class="method"><code>pub fn <a href="#method.cache_keygen" class="fnname">cache_keygen</a>(self, keygen: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> Self</code><a class="srclink" href="../src/actix_redis/session.rs.html#110-113" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a custom cache key generation strategy, expecting session key as input.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Transform%3CS%3E" class="impl"><code class="in-band">impl<S, B> Transform<S> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a> <span class="where fmt-newline">where<br> S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,<br> S::Future: 'static,<br> B: 'static, </span></code><a href="#impl-Transform%3CS%3E" class="anchor"></a><a class="srclink" href="../src/actix_redis/session.rs.html#116-136" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Request" class="type"><code>type <a href="#associatedtype.Request" class="type">Request</a> = ServiceRequest</code></h4><div class='docblock'><p>Requests handled by the service.</p>
|
||||
</div><h4 id="associatedtype.Response" class="type"><code>type <a href="#associatedtype.Response" class="type">Response</a> = ServiceResponse<B></code></h4><div class='docblock'><p>Responses given by the service.</p>
|
||||
</div><h4 id="associatedtype.Error" class="type"><code>type <a href="#associatedtype.Error" class="type">Error</a> = S::Error</code></h4><div class='docblock'><p>Errors produced by the service.</p>
|
||||
</div><h4 id="associatedtype.InitError" class="type"><code>type <a href="#associatedtype.InitError" class="type">InitError</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><div class='docblock'><p>Errors produced while building a transform service.</p>
|
||||
</div><h4 id="associatedtype.Transform" class="type"><code>type <a href="#associatedtype.Transform" class="type">Transform</a> = RedisSessionMiddleware<S></code></h4><div class='docblock'><p>The <code>TransformService</code> value created by this factory</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="#associatedtype.Future" class="type">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::Transform, Self::InitError>></code></h4><div class='docblock'><p>The future response value.</p>
|
||||
</div><h4 id="method.new_transform" class="method hidden"><code>fn <a href="#method.new_transform" class="fnname">new_transform</a>(&self, service: S) -> Self::Future</code><a class="srclink" href="../src/actix_redis/session.rs.html#122-127" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
|
||||
</div><h4 id="method.new_transform" class="method hidden"><code>fn <a href="#method.new_transform" class="fnname">new_transform</a>(&self, service: S) -> Self::Future</code><a class="srclink" href="../src/actix_redis/session.rs.html#130-135" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
|
||||
</div><h4 id="method.map_init_err" class="method hidden"><code>pub fn <a href="#method.map_init_err" class="fnname">map_init_err</a><F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> <span class="where fmt-newline">where<br> F: <a class="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 + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code></h4><div class='docblock hidden'><p>Map this transforms's factory error to a different error,
|
||||
returning a new transform service factory. <a href="#method.map_init_err">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../src/actix_redis/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../src/actix_redis/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../src/actix_redis/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../src/actix_redis/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_redis/struct.RedisSession.html" title="struct actix_redis::RedisSession">RedisSession</a></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../src/actix_redis/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
|
||||
Reference in New Issue
Block a user