1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-28 01:32:57 +01:00
actix-extras/actix_session/storage/index.html

28 lines
8.2 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."><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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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 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">&#9776;</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"><button type="button" id="help-button" title="help">?</button><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-26">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</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.63.0-nightly (dc80ca78b 2022-06-21)" ></div>
</body></html>