actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 07:53:00 +01:00
Code Issues Releases Wiki Activity
378b4c17ba
actix-extras/actix_session/index.html

50 lines
10 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 700d90b68bcf07096ead9b91fc4c5360509081eb 🚀
2021-12-11 02:01:35 +01:00
<!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="Sessions for Actix Web."><meta name="keywords" content="rust, rustlang, rust-lang, actix_session"><title>actix_session - 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 src="../crates.js"></script><script defer src="../main.js"></script>
Deploying to gh-pages from @ 4e72e3d8ec66d1be1667c840b28ab35c32ebae46 🚀
2022-01-21 21:49:16 +01:00
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[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 class="rust-logo" src="../rust-logo.svg" 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 class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
Deploying to gh-pages from @ ef8f33e3b3c26b5a5015885cf70f92ec0568003a 🚀
2022-03-01 05:14:59 +01:00
</a><h2 class="location"><a href="#">Crate actix_session</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.5.0</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><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 id="sidebar-vars" data-name="actix_session" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../actix_session/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
Deploying to gh-pages from @ 323d01fcca69f240957682ef6d3d789e27af3b3a 🚀
2022-02-03 23:36:18 +01:00
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">actix_session</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/lib.rs.html#1-380">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>Sessions for Actix Web.</p>
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<p>Provides a general solution for session management. Session middleware could provide different
implementations which could be accessed via general session API.</p>
<p>This crate provides a general solution for session management and includes a cookie backend.
Other backend implementations can be built to use persistent or key-value stores, for example.</p>
Deploying to gh-pages from @ 20ef05c36e9457b1f593831a06df68426db35b00 🚀
2021-06-27 08:05:12 +02:00
<p>In general, some session middleware, such as a <a href="struct.CookieSession.html" title="CookieSession"><code>CookieSession</code></a> is initialized and applied.
To access session data, the <a href="struct.Session.html" title="Session"><code>Session</code></a> extractor must be used. This extractor allows reading
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
modifying session data.</p>
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpServer</span>, <span class="ident">HttpResponse</span>, <span class="ident">Error</span>};
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<span class="kw">use</span> <span class="ident">actix_session</span>::{<span class="ident">Session</span>, <span class="ident">CookieSession</span>};
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">session</span>: <span class="ident">Session</span>) -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span>, <span class="ident">Error</span><span class="op">&gt;</span> {
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<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">session</span>.<span class="ident">get</span>::<span class="op">&lt;</span><span class="ident">i32</span><span class="op">&gt;</span>(<span class="string">&quot;counter&quot;</span>)<span class="question-mark">?</span> {
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
<span class="macro">println!</span>(<span class="string">&quot;SESSION value: {}&quot;</span>, <span class="ident">count</span>);
Deploying to gh-pages from @ fc6563a019ce9473da3e5af5b1f03a52502d9c6f 🚀
2021-03-23 23:38:11 +01:00
<span class="ident">session</span>.<span class="ident">insert</span>(<span class="string">&quot;counter&quot;</span>, <span class="ident">count</span> <span class="op">+</span> <span class="number">1</span>)<span class="question-mark">?</span>;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
} <span class="kw">else</span> {
Deploying to gh-pages from @ fc6563a019ce9473da3e5af5b1f03a52502d9c6f 🚀
2021-03-23 23:38:11 +01:00
<span class="ident">session</span>.<span class="ident">insert</span>(<span class="string">&quot;counter&quot;</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
}
<span class="prelude-val">Ok</span>(<span class="string">&quot;Welcome!&quot;</span>)
}
Deploying to gh-pages from @ 25d3d34927684e79b33dee75452802afea653708 🚀
2022-02-03 23:47:54 +01:00
<span class="attribute">#[<span class="ident">actix_web::main</span>]</span>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() -&gt; <span class="ident">std::io::Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
<span class="ident">HttpServer::new</span>(
<span class="op">|</span><span class="op">|</span> <span class="ident">App::new</span>()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<span class="comment">// create cookie based session middleware</span>
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
.<span class="ident">wrap</span>(<span class="ident">CookieSession::signed</span>(<span class="kw-2">&amp;</span>[<span class="number">0</span>; <span class="number">32</span>]).<span class="ident">secure</span>(<span class="bool-val">false</span>))
.<span class="ident">default_service</span>(<span class="ident">web::to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse::Ok</span>())))
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
.<span class="ident">bind</span>((<span class="string">&quot;127.0.0.1&quot;</span>, <span class="number">8080</span>))<span class="question-mark">?</span>
.<span class="ident">run</span>()
.<span class="kw">await</span>
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
}</code></pre></div>
Deploying to gh-pages from @ 700d90b68bcf07096ead9b91fc4c5360509081eb 🚀
2021-12-11 02:01:35 +01:00
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CookieSession.html" title="actix_session::CookieSession struct">CookieSession</a></div><div class="item-right docblock-short"><p>Use cookies for session storage.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Session.html" title="actix_session::Session struct">Session</a></div><div class="item-right docblock-short"><p>The high-level interface you use to modify session data.</p>
Deploying to gh-pages from @ 700d90b68bcf07096ead9b91fc4c5360509081eb 🚀
2021-12-11 02:01:35 +01:00
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SessionStatus.html" title="actix_session::SessionStatus enum">SessionStatus</a></div><div class="item-right docblock-short"><p>Status of a <a href="struct.Session.html" title="Session"><code>Session</code></a>.</p>
Deploying to gh-pages from @ 700d90b68bcf07096ead9b91fc4c5360509081eb 🚀
2021-12-11 02:01:35 +01:00
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UserSession.html" title="actix_session::UserSession trait">UserSession</a></div><div class="item-right docblock-short"><p>Extraction of a <a href="struct.Session.html" title="Session"><code>Session</code></a> object.</p>
Deploying to gh-pages from @ ef8f33e3b3c26b5a5015885cf70f92ec0568003a 🚀
2022-03-01 05:14:59 +01:00
</div></div></div></section><section id="search" class="content hidden"></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.61.0-nightly (4ce374923 2022-02-28)" ></div>
Deploying to gh-pages from @ 20ef05c36e9457b1f593831a06df68426db35b00 🚀
2021-06-27 08:05:12 +02:00
</body></html>
Reference in New Issue Copy Permalink