1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 16:02:59 +01:00
actix-extras/actix_session/storage/index.html

6 lines
7.8 KiB
HTML
Raw Normal View History

<!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."><title>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-4e54bb2b497cc83f.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.77.0-nightly (a2d9d73e6 2024-01-10)" data-channel="nightly" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-0b2e2def73e61cbe.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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" title="show sidebar"></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.9.0</span></h2></div><h2 class="location"><a href="#">Module storage</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section><h2><a href="../index.html">In crate actix_session</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../actix_session/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">actix_session</a>::<wbr><a class="mod" href="#">storage</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/actix_session/storage/mod.rs.html#1-28">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="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="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CookieSessionStore.html" title="struct actix_session::storage::CookieSessionStore">CookieSessionStore</a></div><div class="desc docblock-short">Use the session key, stored in the session cookie, as storage backend for the session state.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore">RedisActorSessionStore</a></div><div class="desc docblock-short">Use Redis as session storage backend.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisActorSessionStoreBuilder.html" title="struct actix_session::storage::RedisActorSessionStoreBuilder">RedisActorSessionStoreBuilder</a></div><div class="desc docblock-short">A fluent builder to construct a <a href="struct.RedisActorSessionStore.html" title="struct actix_session::storage::RedisActorSessionStore"><code>RedisActorSessionStore</code></a> instance with custom configuration
parameters.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisSessionStore.html" title="struct actix_session::storage::RedisSessionStore">RedisSessionStore</a></div><div class="desc docblock-short">Use Redis as session storage backend.</div></li><li><div class="item-name"><a class="struct" href="struct.RedisSessionStoreBuilder.html" title="struct actix_session::storage::RedisSessionStoreBuilder">RedisSessionStoreBuilder</a></div><div class="desc docblock-short">A fluent builder to construct a <a href="struct.RedisSessionStore.html" title="struct actix_session::storage::RedisSessionStore"><code>RedisSessionStore</code></a> instance with custom configuration
parameters.</div></li><li><div class="item-name"><a class="struct" href="struct.SessionKey.html" title="struct actix_session::storage::SessionKey">SessionKey</a></div><div class="desc 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></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.LoadError.html" title="enum actix_session::storage::LoadError">LoadError</a></div><div class="desc docblock-short">Possible failures modes for <a href="trait.SessionStore.html#tymethod.load" title="method actix_session::storage::SessionStore::load"><code>SessionStore::load</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.SaveError.html" title="enum actix_session::storage::SaveError">SaveError</a></div><div class="desc docblock-short">Possible failures modes for <a href="trait.SessionStore.html#tymethod.save" title="method actix_session::storage::SessionStore::save"><code>SessionStore::save</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.UpdateError.html" title="enum actix_session::storage::UpdateError">UpdateError</a></div><div class="desc docblock-short">Possible failures modes for <a href="trait.SessionStore.html#tymethod.update" title="method actix_session::storage::SessionStore::update"><code>SessionStore::update</code></a>.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a></div><div class="desc docblock-short">The interface to retrieve and save the current session data from/to the chosen storage backend.</div></li></ul></section></div></main></body></html>