mirror of
https://github.com/actix/actix-website
synced 2024-12-18 18:03:12 +01:00
122 lines
13 KiB
HTML
122 lines
13 KiB
HTML
<!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="API documentation for the Rust `session` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, session"><title>actix_web::middleware::session - Rust</title><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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Module session</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>middleware</a></p><script>window.sidebarCurrent = {name: 'session', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/actix_web/middleware/session.rs.html#1-617' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>middleware</a>::<wbr><a class="mod" href=''>session</a></span></h1><div class='docblock'><p>User sessions.</p>
|
||
<p>Actix provides a general solution for session management. The
|
||
<a href="struct.SessionStorage.html"><strong>SessionStorage</strong></a>
|
||
middleware can be used with different backend types to store session
|
||
data in different backends.</p>
|
||
<p>By default, only cookie session backend is implemented. Other
|
||
backend implementations can be added.</p>
|
||
<p><a href="struct.CookieSessionBackend.html"><strong>CookieSessionBackend</strong></a>
|
||
uses cookies as session storage. <code>CookieSessionBackend</code> creates sessions
|
||
which are limited to storing fewer than 4000 bytes of data, as the payload
|
||
must fit into a single cookie. An internal server error is generated if a
|
||
session contains more than 4000 bytes.</p>
|
||
<p>A cookie may have a security policy of <em>signed</em> or <em>private</em>. Each has
|
||
a respective <code>CookieSessionBackend</code> constructor.</p>
|
||
<p>A <em>signed</em> cookie may be viewed but not modified by the client. A <em>private</em>
|
||
cookie may neither be viewed nor modified by the client.</p>
|
||
<p>The constructors take a key as an argument. This is the private key
|
||
for cookie session - when this value is changed, all session data is lost.</p>
|
||
<p>In general, you create a <code>SessionStorage</code> middleware and initialize it
|
||
with specific backend implementation, such as a <code>CookieSessionBackend</code>.
|
||
To access session data,
|
||
<a href="trait.RequestSession.html#tymethod.session"><em>HttpRequest::session()</em></a>
|
||
must be used. This method returns a
|
||
<a href="struct.Session.html"><em>Session</em></a> object, which allows us to get or set
|
||
session data.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">actix</span>, <span class="ident">server</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="prelude-ty">Result</span>};
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">middleware</span>::<span class="ident">session</span>::{<span class="ident">RequestSession</span>, <span class="ident">SessionStorage</span>, <span class="ident">CookieSessionBackend</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">req</span>: <span class="ident">HttpRequest</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||
<span class="comment">// access session data</span>
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">count</span>) <span class="op">=</span> <span class="ident">req</span>.<span class="ident">session</span>().<span class="ident">get</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>(<span class="string">"counter"</span>)<span class="question-mark">?</span> {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"SESSION value: {}"</span>, <span class="ident">count</span>);
|
||
<span class="ident">req</span>.<span class="ident">session</span>().<span class="ident">set</span>(<span class="string">"counter"</span>, <span class="ident">count</span><span class="op">+</span><span class="number">1</span>)<span class="question-mark">?</span>;
|
||
} <span class="kw">else</span> {
|
||
<span class="ident">req</span>.<span class="ident">session</span>().<span class="ident">set</span>(<span class="string">"counter"</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(<span class="string">"Welcome!"</span>)
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="ident">actix</span>::<span class="ident">System</span>::<span class="ident">run</span>(<span class="op">||</span> {
|
||
<span class="ident">server</span>::<span class="ident">new</span>(
|
||
<span class="op">||</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">middleware</span>(
|
||
<span class="ident">SessionStorage</span>::<span class="ident">new</span>( <span class="comment">// <- create session middleware</span>
|
||
<span class="ident">CookieSessionBackend</span>::<span class="ident">signed</span>(<span class="kw-2">&</span>[<span class="number">0</span>; <span class="number">32</span>]) <span class="comment">// <- create signed cookie session backend</span>
|
||
.<span class="ident">secure</span>(<span class="bool-val">false</span>)
|
||
)))
|
||
.<span class="ident">bind</span>(<span class="string">"127.0.0.1:59880"</span>).<span class="ident">unwrap</span>()
|
||
.<span class="ident">start</span>();
|
||
});
|
||
}</pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CookieSession.html"
|
||
title='struct actix_web::middleware::session::CookieSession'>CookieSession</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Session that uses signed cookies as session storage</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CookieSessionBackend.html"
|
||
title='struct actix_web::middleware::session::CookieSessionBackend'>CookieSessionBackend</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Use cookies for session storage.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Session.html"
|
||
title='struct actix_web::middleware::session::Session'>Session</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The high-level interface you use to modify session data.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.SessionStorage.html"
|
||
title='struct actix_web::middleware::session::SessionStorage'>SessionStorage</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Session storage middleware</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.CookieSessionError.html"
|
||
title='enum actix_web::middleware::session::CookieSessionError'>CookieSessionError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Errors that can occur during handling cookie session</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.RequestSession.html"
|
||
title='trait actix_web::middleware::session::RequestSession'>RequestSession</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The helper trait to obtain your session data from a request.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.SessionBackend.html"
|
||
title='trait actix_web::middleware::session::SessionBackend'>SessionBackend</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Session's storage backend trait definition.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.SessionImpl.html"
|
||
title='trait actix_web::middleware::session::SessionImpl'>SessionImpl</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A simple key-value storage interface that is internally used by <code>Session</code>.</p>
|
||
|
||
</td>
|
||
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |