actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2025-07-01 17:15:08 +02:00
Code Issues Releases Wiki Activity

update actix-web api docs

Browse Source
This commit is contained in:
Nikolay Kim
2018-10-10 08:38:33 -07:00
parent 29977f4930
commit bf8faa455d
2298 changed files with 129471 additions and 17241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
static/api/actix-web/stable/src/actix_web/middleware/session.rs.html
View File

@ -613,6 +613,8 @@
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
</pre><pre class="rust ">
<span class="doccomment">//! User sessions.</span>
<span class="doccomment">//!</span>
@ -886,14 +888,17 @@
}
<span class="doccomment">/// A simple key-value storage interface that is internally used by `Session`.</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">SessionImpl</span>: <span class="lifetime">&#39;static</span> {
<span class="doccomment">/// Get session value by key</span>
<span class="kw">fn</span> <span class="ident">get</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span>;
<span class="doccomment">/// Set session value</span>
<span class="kw">fn</span> <span class="ident">set</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">value</span>: <span class="ident">String</span>);
<span class="doccomment">/// Remove specific key from session</span>
<span class="kw">fn</span> <span class="ident">remove</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>);
<span class="doccomment">/// Remove all values from session</span>
<span class="kw">fn</span> <span class="ident">clear</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>);
<span class="doccomment">/// Write session to storage backend.</span>
@ -901,9 +906,10 @@
}
<span class="doccomment">/// Session&#39;s storage backend trait definition.</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">SessionBackend</span><span class="op">&lt;</span><span class="ident">S</span><span class="op">&gt;</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="lifetime">&#39;static</span> {
<span class="doccomment">/// Session item</span>
<span class="kw">type</span> <span class="ident">Session</span>: <span class="ident">SessionImpl</span>;
<span class="doccomment">/// Future that reads session</span>
<span class="kw">type</span> <span class="ident">ReadFuture</span>: <span class="ident">Future</span><span class="op">&lt;</span><span class="ident">Item</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Session</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">Error</span><span class="op">&gt;</span>;
<span class="doccomment">/// Parse the session from request and load data from a storage backend.</span>
@ -1195,8 +1201,7 @@
<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="ident">CookieSessionBackend</span>::<span class="ident">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">resource</span>(<span class="string">&quot;/&quot;</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
)).<span class="ident">resource</span>(<span class="string">&quot;/&quot;</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
<span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="ident">req</span><span class="op">|</span> {
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">session</span>().<span class="ident">set</span>(<span class="string">&quot;counter&quot;</span>, <span class="number">100</span>);
<span class="string">&quot;test&quot;</span>
@ -1215,8 +1220,7 @@
<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="ident">CookieSessionBackend</span>::<span class="ident">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">resource</span>(<span class="string">&quot;/&quot;</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
)).<span class="ident">resource</span>(<span class="string">&quot;/&quot;</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
<span class="ident">r</span>.<span class="ident">with</span>(<span class="op">|</span><span class="ident">ses</span>: <span class="ident">Session</span><span class="op">|</span> {
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">ses</span>.<span class="ident">set</span>(<span class="string">&quot;counter&quot;</span>, <span class="number">100</span>);
<span class="string">&quot;test&quot;</span>