mirror of
https://github.com/actix/actix-extras.git
synced 2025-08-30 19:10:20 +02:00
Deploying to gh-pages from @ d98ebf2bdf 🚀
This commit is contained in:
robjtede
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,17 +1,7 @@
|
||||
<!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="Pluggable storage backends for session state."><meta name="keywords" content="rust, rustlang, rust-lang, storage"><title>actix_session::storage - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc mod"><!--[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">☰</button><a class="sidebar-logo" href="../../actix_session/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../actix_session/index.html"><div class="logo-container">
|
||||
<img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"><a href="#">Module storage</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_session/index.html">
|
||||
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">actix_session</a>::<wbr><a class="mod" href="#">storage</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/actix_session/storage/mod.rs.html#1-28">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Pluggable storage backends for session state.</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CookieSessionStore.html" title="actix_session::storage::CookieSessionStore struct">CookieSessionStore</a></div><div class="item-right docblock-short"><p>Use the session key, stored in the session cookie, as storage backend for the session state.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisActorSessionStore.html" title="actix_session::storage::RedisActorSessionStore struct">RedisActorSessionStore</a></div><div class="item-right docblock-short"><p>Use Redis as session storage backend.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisActorSessionStoreBuilder.html" title="actix_session::storage::RedisActorSessionStoreBuilder struct">RedisActorSessionStoreBuilder</a></div><div class="item-right docblock-short"><p>A fluent builder to construct a <a href="struct.RedisActorSessionStore.html" title="RedisActorSessionStore"><code>RedisActorSessionStore</code></a> instance with custom configuration
|
||||
parameters.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisSessionStore.html" title="actix_session::storage::RedisSessionStore struct">RedisSessionStore</a></div><div class="item-right docblock-short"><p>Use Redis as session storage backend.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisSessionStoreBuilder.html" title="actix_session::storage::RedisSessionStoreBuilder struct">RedisSessionStoreBuilder</a></div><div class="item-right docblock-short"><p>A fluent builder to construct a <a href="struct.RedisSessionStore.html"><code>RedisSessionStore</code></a> instance with custom configuration
|
||||
parameters.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SessionKey.html" title="actix_session::storage::SessionKey struct">SessionKey</a></div><div class="item-right docblock-short"><p>A session key, the string stored in a client-side cookie to associate a user with its session
|
||||
state on the backend.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LoadError.html" title="actix_session::storage::LoadError enum">LoadError</a></div><div class="item-right docblock-short"><p>Possible failures modes for <a href="trait.SessionStore.html#tymethod.load" title="SessionStore::load"><code>SessionStore::load</code></a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SaveError.html" title="actix_session::storage::SaveError enum">SaveError</a></div><div class="item-right docblock-short"><p>Possible failures modes for <a href="trait.SessionStore.html#tymethod.save" title="SessionStore::save"><code>SessionStore::save</code></a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UpdateError.html" title="actix_session::storage::UpdateError enum">UpdateError</a></div><div class="item-right docblock-short"><p>Possible failures modes for <a href="trait.SessionStore.html#tymethod.update" title="SessionStore::update"><code>SessionStore::update</code></a>.</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SessionStore.html" title="actix_session::storage::SessionStore trait">SessionStore</a></div><div class="item-right docblock-short"><p>The interface to retrieve and save the current session data from/to the chosen storage backend.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (228710758 2022-09-10)" ></div></body></html>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CookieSessionStore.html" title="actix_session::storage::CookieSessionStore struct">CookieSessionStore</a></div><div class="item-right docblock-short">Use the session key, stored in the session cookie, as storage backend for the session state.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisActorSessionStore.html" title="actix_session::storage::RedisActorSessionStore struct">RedisActorSessionStore</a></div><div class="item-right docblock-short">Use Redis as session storage backend.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisActorSessionStoreBuilder.html" title="actix_session::storage::RedisActorSessionStoreBuilder struct">RedisActorSessionStoreBuilder</a></div><div class="item-right docblock-short">A fluent builder to construct a <a href="struct.RedisActorSessionStore.html" title="RedisActorSessionStore"><code>RedisActorSessionStore</code></a> instance with custom configuration
|
||||
parameters.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisSessionStore.html" title="actix_session::storage::RedisSessionStore struct">RedisSessionStore</a></div><div class="item-right docblock-short">Use Redis as session storage backend.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RedisSessionStoreBuilder.html" title="actix_session::storage::RedisSessionStoreBuilder struct">RedisSessionStoreBuilder</a></div><div class="item-right docblock-short">A fluent builder to construct a <a href="struct.RedisSessionStore.html"><code>RedisSessionStore</code></a> instance with custom configuration
|
||||
parameters.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SessionKey.html" title="actix_session::storage::SessionKey struct">SessionKey</a></div><div class="item-right docblock-short">A session key, the string stored in a client-side cookie to associate a user with its session
|
||||
state on the backend.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LoadError.html" title="actix_session::storage::LoadError enum">LoadError</a></div><div class="item-right docblock-short">Possible failures modes for <a href="trait.SessionStore.html#tymethod.load" title="SessionStore::load"><code>SessionStore::load</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SaveError.html" title="actix_session::storage::SaveError enum">SaveError</a></div><div class="item-right docblock-short">Possible failures modes for <a href="trait.SessionStore.html#tymethod.save" title="SessionStore::save"><code>SessionStore::save</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UpdateError.html" title="actix_session::storage::UpdateError enum">UpdateError</a></div><div class="item-right docblock-short">Possible failures modes for <a href="trait.SessionStore.html#tymethod.update" title="SessionStore::update"><code>SessionStore::update</code></a>.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SessionStore.html" title="actix_session::storage::SessionStore trait">SessionStore</a></div><div class="item-right docblock-short">The interface to retrieve and save the current session data from/to the chosen storage backend.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (432abd86f 2022-09-20)" ></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,11 +1,11 @@
|
||||
<!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="The interface to retrieve and save the current session data from/to the chosen storage backend."><meta name="keywords" content="rust, rustlang, rust-lang, SessionStore"><title>SessionStore in actix_session::storage - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc trait"><!--[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">☰</button><a class="sidebar-logo" href="../../actix_session/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../actix_session/index.html"><div class="logo-container">
|
||||
<img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"><a href="#">SessionStore</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.delete">delete</a></li><li><a href="#tymethod.load">load</a></li><li><a href="#tymethod.save">save</a></li><li><a href="#tymethod.update">update</a></li><li><a href="#tymethod.update_ttl">update_ttl</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In actix_session::storage</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_session/index.html">
|
||||
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">actix_session</a>::<wbr><a href="index.html">storage</a>::<wbr><a class="trait" href="#">SessionStore</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/actix_session/storage/interface.rs.html#18-48">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait SessionStore {
|
||||
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">actix_session</a>::<wbr><a href="index.html">storage</a>::<wbr><a class="trait" href="#">SessionStore</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/actix_session/storage/interface.rs.html#18-48">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SessionStore {
|
||||
fn <a href="#tymethod.load" class="fnname">load</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a><br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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><<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>>>, <a class="enum" href="enum.LoadError.html" title="enum actix_session::storage::LoadError">LoadError</a>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
<span class="item-spacer"></span> fn <a href="#tymethod.save" class="fnname">save</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> 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><<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>>,<br> ttl: &'life1 Duration<br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
<span class="item-spacer"></span> fn <a href="#tymethod.update" class="fnname">update</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br> 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><<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>>,<br> ttl: &'life1 Duration<br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
<span class="item-spacer"></span> fn <a href="#tymethod.update_ttl" class="fnname">update_ttl</a><'life0, 'life1, 'life2, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br> ttl: &'life2 Duration<br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.64/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> 'life2: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
<span class="item-spacer"></span> fn <a href="#tymethod.delete" class="fnname">delete</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a><br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.64/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
<span class="item-spacer"></span> fn <a href="#tymethod.update_ttl" class="fnname">update_ttl</a><'life0, 'life1, 'life2, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br> ttl: &'life2 Duration<br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.65/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> 'life2: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
<span class="item-spacer"></span> fn <a href="#tymethod.delete" class="fnname">delete</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a><br> ) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.65/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><br> <span class="where">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait</span>;
|
||||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The interface to retrieve and save the current session data from/to the chosen storage backend.</p>
|
||||
<p>You can provide your own custom session store backend by implementing this trait.</p>
|
||||
<p><a href="https://docs.rs/async-trait"><code>async-trait</code></a> is used for this trait’s definition. Therefore, it
|
||||
@@ -15,6 +15,6 @@ is required for implementations, too. In particular, we use the send-optional va
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.save" class="method has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/interface.rs.html#25-29">source</a><h4 class="code-header">fn <a href="#tymethod.save" class="fnname">save</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> 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><<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>>,<br> ttl: &'life1 Duration<br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>>> + 'async_trait>><span class="where fmt-newline">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait,</span></h4></div></summary><div class="docblock"><p>Persist the session state for a newly created session.</p>
|
||||
<p>Returns the corresponding session key.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.update" class="method has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/interface.rs.html#32-37">source</a><h4 class="code-header">fn <a href="#tymethod.update" class="fnname">update</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br> 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><<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>>,<br> ttl: &'life1 Duration<br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>>> + 'async_trait>><span class="where fmt-newline">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait,</span></h4></div></summary><div class="docblock"><p>Updates the session state associated to a pre-existing session key.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.update_ttl" class="method has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/interface.rs.html#40-44">source</a><h4 class="code-header">fn <a href="#tymethod.update_ttl" class="fnname">update_ttl</a><'life0, 'life1, 'life2, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br> ttl: &'life2 Duration<br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.64/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><span class="where fmt-newline">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> 'life2: 'async_trait,<br> Self: 'async_trait,</span></h4></div></summary><div class="docblock"><p>Updates the TTL of the session state associated to a pre-existing session key.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.delete" class="method has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/interface.rs.html#47">source</a><h4 class="code-header">fn <a href="#tymethod.delete" class="fnname">delete</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a><br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.64/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><span class="where fmt-newline">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait,</span></h4></div></summary><div class="docblock"><p>Deletes a session from the store.</p>
|
||||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-SessionStore-for-CookieSessionStore" class="impl has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/cookie.rs.html#56-100">source</a><a href="#impl-SessionStore-for-CookieSessionStore" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a> for <a class="struct" href="struct.CookieSessionStore.html" title="struct actix_session::storage::CookieSessionStore">CookieSessionStore</a></h3></section><section id="impl-SessionStore-for-RedisActorSessionStore" class="impl has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/redis_actor.rs.html#124-277">source</a><a href="#impl-SessionStore-for-RedisActorSessionStore" class="anchor"></a><h3 class="code-header in-band">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><section id="impl-SessionStore-for-RedisSessionStore" class="impl has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/redis_rs.rs.html#138-250">source</a><a href="#impl-SessionStore-for-RedisSessionStore" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a> for <a class="struct" href="struct.RedisSessionStore.html" title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</a></h3></section></div><script src="../../implementors/actix_session/storage/interface/trait.SessionStore.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (228710758 2022-09-10)" ></div></body></html>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.update_ttl" class="method has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/interface.rs.html#40-44">source</a><h4 class="code-header">fn <a href="#tymethod.update_ttl" class="fnname">update_ttl</a><'life0, 'life1, 'life2, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br> ttl: &'life2 Duration<br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.65/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><span class="where fmt-newline">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> 'life2: 'async_trait,<br> Self: 'async_trait,</span></h4></div></summary><div class="docblock"><p>Updates the TTL of the session state associated to a pre-existing session key.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.delete" class="method has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/interface.rs.html#47">source</a><h4 class="code-header">fn <a href="#tymethod.delete" class="fnname">delete</a><'life0, 'life1, 'async_trait>(<br> &'life0 self,<br> session_key: &'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a><br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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.65/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>> + 'async_trait>><span class="where fmt-newline">where<br> 'life0: 'async_trait,<br> 'life1: 'async_trait,<br> Self: 'async_trait,</span></h4></div></summary><div class="docblock"><p>Deletes a session from the store.</p>
|
||||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-SessionStore-for-CookieSessionStore" class="impl has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/cookie.rs.html#56-100">source</a><a href="#impl-SessionStore-for-CookieSessionStore" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a> for <a class="struct" href="struct.CookieSessionStore.html" title="struct actix_session::storage::CookieSessionStore">CookieSessionStore</a></h3></section><section id="impl-SessionStore-for-RedisActorSessionStore" class="impl has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/redis_actor.rs.html#124-277">source</a><a href="#impl-SessionStore-for-RedisActorSessionStore" class="anchor"></a><h3 class="code-header in-band">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><section id="impl-SessionStore-for-RedisSessionStore" class="impl has-srclink"><a class="srclink rightside" href="../../src/actix_session/storage/redis_rs.rs.html#138-250">source</a><a href="#impl-SessionStore-for-RedisSessionStore" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a> for <a class="struct" href="struct.RedisSessionStore.html" title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</a></h3></section></div><script src="../../implementors/actix_session/storage/interface/trait.SessionStore.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (432abd86f 2022-09-20)" ></div></body></html>
|
||||
Reference in New Issue
Block a user