actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2025-08-30 19:10:20 +02:00
Code Issues Releases Wiki Activity

Deploying to gh-pages from @ d28ab6eaa1 🚀

Browse Source
This commit is contained in:
robjtede
2022-09-22 11:49:04 +00:00
parent f4e752841b
commit e7f0769bef
181 changed files with 190 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
actix_session/storage/enum.LoadError.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/enum.SaveError.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/enum.UpdateError.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/index.html
View File

@@ -4,4 +4,4 @@
</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>
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 (9062b780b 2022-09-21)" ></div></body></html>

2
actix_session/storage/struct.CookieSessionStore.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/struct.RedisActorSessionStore.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/struct.RedisActorSessionStoreBuilder.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/struct.RedisSessionStore.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/struct.RedisSessionStoreBuilder.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/struct.SessionKey.html
View File

File diff suppressed because one or more lines are too long

2
actix_session/storage/trait.SessionStore.html
View File

@@ -17,4 +17,4 @@ is required for implementations, too. In particular, we use the send-optional va
</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>&lt;'life0, 'life1, 'async_trait&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'life0 self,<br>&nbsp;&nbsp;&nbsp;&nbsp;session_key: <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;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;,<br>&nbsp;&nbsp;&nbsp;&nbsp;ttl: &amp;'life1 Duration<br>) -&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;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'life0: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;'life1: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;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>&lt;'life0, 'life1, 'life2, 'async_trait&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'life0 self,<br>&nbsp;&nbsp;&nbsp;&nbsp;session_key: &amp;'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;ttl: &amp;'life2 Duration<br>) -&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.65/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;&gt; + 'async_trait&gt;&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'life0: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;'life1: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;'life2: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;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>&lt;'life0, 'life1, 'async_trait&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'life0 self,<br>&nbsp;&nbsp;&nbsp;&nbsp;session_key: &amp;'life1 <a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a><br>) -&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.65/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;&gt; + 'async_trait&gt;&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'life0: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;'life1: 'async_trait,<br>&nbsp;&nbsp;&nbsp;&nbsp;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>
</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 (9062b780b 2022-09-21)" ></div></body></html>