actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2025-08-19 15:05:36 +02:00
Code Issues Releases Wiki Activity

Deploying to gh-pages from @ actix/actix-extras@b694c9317a 🚀

Browse Source
This commit is contained in:
robjtede
2024-01-04 03:42:51 +00:00
parent b42e91826c
commit 37cf1fd1eb
65 changed files with 181 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
actix_session/struct.Session.html
View File

@@ -17,7 +17,7 @@ request handlers and it will be automatically extracted from the incoming reques
}</code></pre></div>
<p>You can also retrieve a <a href="struct.Session.html" title="struct actix_session::Session"><code>Session</code></a> object from an <code>HttpRequest</code> or a <code>ServiceRequest</code> using
<a href="trait.SessionExt.html" title="trait actix_session::SessionExt"><code>SessionExt</code></a>.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Session" class="impl"><a class="src rightside" href="../src/actix_session/session.rs.html#77-257">source</a><a href="#impl-Session" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#81-98">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>&lt;T: <a class="trait" href="https://docs.rs/serde/1.0.193/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>&gt;(
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Session" class="impl"><a class="src rightside" href="../src/actix_session/session.rs.html#77-257">source</a><a href="#impl-Session" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Session.html" title="struct actix_session::Session">Session</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#81-98">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>&lt;T: <a class="trait" href="https://docs.rs/serde/1.0.194/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>&gt;(
&amp;self,
key: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;, <a class="struct" href="struct.SessionGetError.html" title="struct actix_session::SessionGetError">SessionGetError</a>&gt;</h4></section></summary><div class="docblock"><p>Get a <code>value</code> from the session.</p>
@@ -25,7 +25,7 @@ request handlers and it will be automatically extracted from the incoming reques
</div></details><details class="toggle method-toggle" open><summary><section id="method.entries" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#103-105">source</a><h4 class="code-header">pub fn <a href="#method.entries" class="fn">entries</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a>&lt;'_, <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Get all raw key-value data from the session.</p>
<p>Note that values are JSON encoded.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.status" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#108-110">source</a><h4 class="code-header">pub fn <a href="#method.status" class="fn">status</a>(&amp;self) -&gt; <a class="enum" href="enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></h4></section></summary><div class="docblock"><p>Returns session status.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#118-146">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>&lt;T: <a class="trait" href="https://docs.rs/serde/1.0.193/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>&gt;(
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#118-146">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>&lt;T: <a class="trait" href="https://docs.rs/serde/1.0.194/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>&gt;(
&amp;self,
key: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
value: T
@@ -35,7 +35,7 @@ only a reference to the value is taken.</p>
<p>It returns an error if it fails to serialize <code>value</code> to JSON.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#151-162">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(&amp;self, key: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</h4></section></summary><div class="docblock"><p>Remove value from the session.</p>
<p>If present, the JSON encoded value is returned.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_as" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#168-182">source</a><h4 class="code-header">pub fn <a href="#method.remove_as" class="fn">remove_as</a>&lt;T: <a class="trait" href="https://docs.rs/serde/1.0.193/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>&gt;(
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_as" class="method"><a class="src rightside" href="../src/actix_session/session.rs.html#168-182">source</a><h4 class="code-header">pub fn <a href="#method.remove_as" class="fn">remove_as</a>&lt;T: <a class="trait" href="https://docs.rs/serde/1.0.194/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>&gt;(
&amp;self,
key: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Remove value from the session and deserialize.</p>