actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-28 09:42:40 +01:00
Code Issues Releases Wiki Activity
64d58ddc01
actix-extras/actix_session/storage/struct.RedisActorSessionStore.html

94 lines
39 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ actix/actix-extras@2f30fd71a91264e596855afe03a533cee8e408ba 🚀
2023-12-06 15:01:24 +01:00
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Use Redis as session storage backend."><title>RedisActorSessionStore in actix_session::storage - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c67e44d78ab2db17.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_session" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0-nightly (e9013ac0e 2023-12-05)" data-channel="nightly" data-search-js="search-5a66c239c06b3a66.js" data-settings-js="settings-fe03fdc259827cd2.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-77dede896d6ac08e.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../../actix_session/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../actix_session/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_session/index.html">actix_session</a><span class="version">0.8.0</span></h2></div><h2 class="location"><a href="#">RedisActorSessionStore</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.builder">builder</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-SessionStore-for-RedisActorSessionStore">SessionStore</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-RedisActorSessionStore">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-RedisActorSessionStore">!Send</a></li><li><a href="#impl-Sync-for-RedisActorSessionStore">!Sync</a></li><li><a href="#impl-UnwindSafe-for-RedisActorSessionStore">!UnwindSafe</a></li><li><a href="#impl-Unpin-for-RedisActorSessionStore">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip&lt;V&gt;</a></li
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{web, App, HttpServer, HttpResponse, Error};
<span class="kw">use </span>actix_session::{SessionMiddleware, storage::RedisActorSessionStore};
<span class="kw">use </span>actix_web::cookie::Key;
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="comment">// The secret key would usually be read from a configuration file/environment variables.
</span><span class="kw">fn </span>get_secret_key() -&gt; Key {
<span class="comment">// [...]
</span>}
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[actix_web::main]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>main() -&gt; std::io::Result&lt;()&gt; {
<span class="kw">let </span>secret_key = get_secret_key();
Deploying to gh-pages from @ actix/actix-extras@2f30fd71a91264e596855afe03a533cee8e408ba 🚀
2023-12-06 15:01:24 +01:00
<span class="kw">let </span>redis_connection_string = <span class="string">"127.0.0.1:6379"</span>;
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
HttpServer::new(<span class="kw">move </span>||
App::new()
.wrap(
SessionMiddleware::new(
RedisActorSessionStore::new(redis_connection_string),
secret_key.clone()
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
)
)
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.default_service(web::to(|| HttpResponse::Ok())))
Deploying to gh-pages from @ actix/actix-extras@2f30fd71a91264e596855afe03a533cee8e408ba 🚀
2023-12-06 15:01:24 +01:00
.bind((<span class="string">"127.0.0.1"</span>, <span class="number">8080</span>))<span class="question-mark">?
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span>.run()
.<span class="kw">await
</span>}</code></pre></div>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<h2 id="implementation-notes"><a href="#implementation-notes">Implementation notes</a></h2>
<p><code>RedisActorSessionStore</code> leverages <code>actix-redis</code>’s <code>RedisActor</code> implementation - each thread
worker gets its own connection to Redis.</p>
<h3 id="limitations"><a href="#limitations">Limitations</a></h3>
<p><code>RedisActorSessionStore</code> does not currently support establishing authenticated connections to
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
Redis. Use <a href="struct.RedisSessionStore.html" title="struct actix_session::storage::RedisSessionStore"><code>RedisSessionStore</code></a> if you need TLS support.</p>
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-RedisActorSessionStore" class="impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#61-79">source</a><a href="#impl-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.builder" class="method"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#66-71">source</a><h4 class="code-header">pub fn <a href="#method.builder" class="fn">builder</a>&lt;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;&gt;(
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
connection_string: S
) -&gt; <a class="struct" href="struct.RedisActorSessionStoreBuilder.html" title="struct actix_session::storage::RedisActorSessionStoreBuilder">RedisActorSessionStoreBuilder</a></h4></section></summary><div class="docblock"><p>A fluent API to configure <a href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a>.</p>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<p>It takes as input the only required input to create a new instance of
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
<a href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a>—a connection string for Redis.</p>
Deploying to gh-pages from @ aaedb9c62542204732ac14a7f339b74ff8337e6c 🚀
2023-09-16 01:32:28 +02:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#76-78">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>&lt;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;&gt;(connection_string: S) -&gt; <a class="struct" href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h4></section></summary><div class="docblock"><p>Create a new instance of <a href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a> using the default configuration.
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
It takes as input the only required input to create a new instance of <a href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a> - a
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
connection string for Redis.</p>
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-SessionStore-for-RedisActorSessionStore" class="impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#122-275">source</a><a href="#impl-SessionStore-for-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a> for <a class="struct" href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.load" class="method trait-impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#123-147">source</a><a href="#method.load" class="anchor">§</a><h4 class="code-header">fn <a href="trait.SessionStore.html#tymethod.load" class="fn">load</a>&lt;'life0, 'life1, 'async_trait&gt;(
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
&amp;'life0 self,
session_key: &amp;'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;&gt;, <a class="enum" href="enum.LoadError.html" title="enum actix_session::storage::LoadError">LoadError</a>&gt;&gt; + 'async_trait&gt;&gt;<div class="where">where
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
Self: 'async_trait,
'life0: 'async_trait,
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
'life1: 'async_trait,</div></h4></section></summary><div class='docblock'>Loads the session state associated to a session key.</div></details><details class="toggle method-toggle" open><summary><section id="method.save" class="method trait-impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#149-188">source</a><a href="#method.save" class="anchor">§</a><h4 class="code-header">fn <a href="trait.SessionStore.html#tymethod.save" class="fn">save</a>&lt;'life0, 'life1, 'async_trait&gt;(
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
&amp;'life0 self,
session_state: <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
ttl: &amp;'life1 Duration
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>, <a class="enum" href="enum.SaveError.html" title="enum actix_session::storage::SaveError">SaveError</a>&gt;&gt; + 'async_trait&gt;&gt;<div class="where">where
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
Self: 'async_trait,
'life0: 'async_trait,
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
'life1: 'async_trait,</div></h4></section></summary><div class='docblock'>Persist the session state for a newly created session. <a href="trait.SessionStore.html#tymethod.save">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.update" class="method trait-impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#190-238">source</a><a href="#method.update" class="anchor">§</a><h4 class="code-header">fn <a href="trait.SessionStore.html#tymethod.update" class="fn">update</a>&lt;'life0, 'life1, 'async_trait&gt;(
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
&amp;'life0 self,
session_key: <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,
session_state: <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
ttl: &amp;'life1 Duration
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>, <a class="enum" href="enum.UpdateError.html" title="enum actix_session::storage::UpdateError">UpdateError</a>&gt;&gt; + 'async_trait&gt;&gt;<div class="where">where
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
Self: 'async_trait,
'life0: 'async_trait,
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
'life1: 'async_trait,</div></h4></section></summary><div class='docblock'>Updates the session state associated to a pre-existing session key.</div></details><details class="toggle method-toggle" open><summary><section id="method.update_ttl" class="method trait-impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#240-256">source</a><a href="#method.update_ttl" class="anchor">§</a><h4 class="code-header">fn <a href="trait.SessionStore.html#tymethod.update_ttl" class="fn">update_ttl</a>&lt;'life0, 'life1, 'life2, 'async_trait&gt;(
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
&amp;'life0 self,
session_key: &amp;'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,
ttl: &amp;'life2 Duration
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.75/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;&gt; + 'async_trait&gt;&gt;<div class="where">where
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
'life2: 'async_trait,</div></h4></section></summary><div class='docblock'>Updates the TTL of the session state associated to a pre-existing session key.</div></details><details class="toggle method-toggle" open><summary><section id="method.delete" class="method trait-impl"><a class="src rightside" href="../../src/actix_session/storage/redis_actor.rs.html#258-274">source</a><a href="#method.delete" class="anchor">§</a><h4 class="code-header">fn <a href="trait.SessionStore.html#tymethod.delete" class="fn">delete</a>&lt;'life0, 'life1, 'async_trait&gt;(
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
&amp;'life0 self,
session_key: &amp;'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.75/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;&gt; + 'async_trait&gt;&gt;<div class="where">where
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
Self: 'async_trait,
'life0: 'async_trait,
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
'life1: 'async_trait,</div></h4></section></summary><div class='docblock'>Deletes a session from the store.</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-RedisActorSessionStore" class="impl"><a href="#impl-RefUnwindSafe-for-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">impl !<a class="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 <a class="struct" href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><section id="impl-Send-for-RedisActorSessionStore" class="impl"><a href="#impl-Send-for-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">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="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><section id="impl-Sync-for-RedisActorSessionStore" class="impl"><a href="#impl-Sync-for-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">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="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><section id="impl-Unpin-for-RedisActorSessionStore" class="impl"><a href="#impl-Unpin-for-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">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="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section><section id="impl-UnwindSafe-for-RedisActorSessionStore" class="impl"><a href="#impl-UnwindSafe-for-RedisActorSessionStore" class="anchor">§</a><h3 class="code-header">impl !<a class="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 <a class="struct" href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
Deploying to gh-pages from @ actix/actix-extras@4bad825456f81e8e621bda912f96a33e80e29832 🚀
2023-10-16 21:09:07 +02:00
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; Instrument for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a class="fn">instrument</a>(self, span: Span) -&gt; Instrumented&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a class="fn">in_current_span</a>(self) -&gt; Instrumented&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="super::Span::current()">current</a> <a href="crate::Span"><code>Span</code></a>, returning an
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
<code>Instrumented</code> wrapper. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<p>That is, this conversion is whatever the implementation of
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Same-for-T" class="impl"><a class="src rightside" href="https://docs.rs/typenum/1.17.0/src/typenum/type_operators.rs.html#34">source</a><a href="#impl-Same-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html" title="trait typenum::type_operators::Same">Same</a> for T</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html#associatedtype.Output" class="associatedtype">Output</a> = T</h4></section></summary><div class='docblock'>Should always be <code>Self</code></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
Deploying to gh-pages from @ actix/actix-extras@2f30fd71a91264e596855afe03a533cee8e408ba 🚀
2023-12-06 15:01:24 +01:00
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="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><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;V, T&gt; VZip&lt;V&gt; for T<div class="where">where
Deploying to gh-pages from @ actix/actix-extras@2d4cf5f422813f6117dd48850f3e23703bb27954 🚀
2023-12-04 17:11:53 +01:00
V: MultiLane&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a href="#method.vzip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">vzip</a>(self) -&gt; V</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; WithSubscriber for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_subscriber</a>&lt;S&gt;(self, subscriber: S) -&gt; WithDispatch&lt;Self&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;Dispatch&gt;,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
Deploying to gh-pages from @ actix/actix-extras@4bad825456f81e8e621bda912f96a33e80e29832 🚀
2023-10-16 21:09:07 +02:00
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_current_subscriber</a>(self) -&gt; WithDispatch&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="crate::dispatcher#setting-the-default-subscriber">default</a> <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details></div></details></div></section></div></main></body></html>
Reference in New Issue Copy Permalink