mirror of
https://github.com/actix/actix-extras.git
synced 2025-07-01 20:25:09 +02:00
Deploying to gh-pages from @ fc6563a019 🚀
This commit is contained in:
robjtede
@ -1,21 +1,32 @@
|
||||
<!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 `SessionStatus` enum in crate `actix_session`."><meta name="keywords" content="rust, rustlang, rust-lang, SessionStatus"><title>actix_session::SessionStatus - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<!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="Status of a [`Session`]."><meta name="keywords" content="rust, rustlang, rust-lang, SessionStatus"><title>actix_session::SessionStatus - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc enum"><!--[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" role="button">☰</div><a href='../actix_session/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Enum SessionStatus</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Changed">Changed</a><a href="#variant.Purged">Purged</a><a href="#variant.Renewed">Renewed</a><a href="#variant.Unchanged">Unchanged</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-PartialEq%3CSessionStatus%3E">PartialEq<SessionStatus></a><a href="#impl-StructuralPartialEq">StructuralPartialEq</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_session</a></p><div id="sidebar-vars" data-name="SessionStatus" data-ty="enum" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Enum <a href="index.html">actix_session</a>::<wbr><a class="enum" href="">SessionStatus</a></span><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_session/lib.rs.html#104-109" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust enum">pub enum SessionStatus {
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Enum <a href="index.html">actix_session</a>::<wbr><a class="enum" href="">SessionStatus</a></span><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_session/lib.rs.html#112-133" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust enum">pub enum SessionStatus {
|
||||
Changed,
|
||||
Purged,
|
||||
Renewed,
|
||||
Unchanged,
|
||||
}</pre></div><h2 id="variants" class="variants small-section-header">
|
||||
}</pre></div><div class="docblock"><p>Status of a <a href="../actix_session/struct.Session.html" title="Session"><code>Session</code></a>.</p>
|
||||
</div><h2 id="variants" class="variants small-section-header">
|
||||
Variants<a href="#variants" class="anchor"></a></h2>
|
||||
<div id="variant.Changed" class="variant small-section-header"><a href="#variant.Changed" class="anchor field"></a><code>Changed</code></div><div id="variant.Purged" class="variant small-section-header"><a href="#variant.Purged" class="anchor field"></a><code>Purged</code></div><div id="variant.Renewed" class="variant small-section-header"><a href="#variant.Renewed" class="anchor field"></a><code>Renewed</code></div><div id="variant.Unchanged" class="variant small-section-header"><a href="#variant.Unchanged" class="anchor field"></a><code>Unchanged</code></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
<div id="variant.Changed" class="variant small-section-header"><a href="#variant.Changed" class="anchor field"></a><code>Changed</code></div><div class="docblock"><p>Session has been updated and requires a new persist operation.</p>
|
||||
</div><div id="variant.Purged" class="variant small-section-header"><a href="#variant.Purged" class="anchor field"></a><code>Purged</code></div><div class="docblock"><p>Session is flagged for deletion and should be removed from client and server.</p>
|
||||
<p>Most operations on the session after purge flag is set should have no effect.</p>
|
||||
</div><div id="variant.Renewed" class="variant small-section-header"><a href="#variant.Renewed" class="anchor field"></a><code>Renewed</code></div><div class="docblock"><p>Session is flagged for refresh.</p>
|
||||
<p>For example, when using a backend that has a TTL (time-to-live) expiry on the session entry,
|
||||
the session will be refreshed even if no data inside it has changed. The client may also
|
||||
be notified of the refresh.</p>
|
||||
</div><div id="variant.Unchanged" class="variant small-section-header"><a href="#variant.Unchanged" class="anchor field"></a><code>Unchanged</code></div><div class="docblock"><p>Session is unchanged from when last seen (if exists).</p>
|
||||
<p>This state also captures new (previously unissued) sessions such as a user’s first
|
||||
site visit.</p>
|
||||
</div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#110-114" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#111-113" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></div><h3 id="impl-PartialEq%3CSessionStatus%3E" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a>> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-PartialEq%3CSessionStatus%3E" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.eq" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#135-139" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#136-138" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></div><h3 id="impl-PartialEq%3CSessionStatus%3E" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a>> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-PartialEq%3CSessionStatus%3E" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.eq" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||||
</div><h4 id="method.ne" class="method hidden"><code><span class="docblock attributes">#[must_use]</span>pub fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#213" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||||
</div></div><h3 id="impl-StructuralPartialEq" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-StructuralPartialEq" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#103" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-StructuralPartialEq" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-StructuralPartialEq" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#111" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#544-548" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!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="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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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" role="button">☰</div><a href='../actix_session/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate actix_session</p><div class="block version"><p>Version 0.4.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all actix_session's items</p></a><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"></p><div id="sidebar-vars" data-name="actix_session" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">actix_session</a></span><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_session/lib.rs.html#1-332" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Sessions for Actix Web.</p>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">actix_session</a></span><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_session/lib.rs.html#1-411" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Sessions for Actix Web.</p>
|
||||
<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.
|
||||
@ -18,9 +18,9 @@ modifying session data.</p>
|
||||
<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"><</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">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="ident">session</span>.<span class="ident">insert</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">session</span>.<span class="ident">set</span>(<span class="string">"counter"</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
|
||||
<span class="ident">session</span>.<span class="ident">insert</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>)
|
||||
@ -41,7 +41,8 @@ modifying session data.</p>
|
||||
<table><tr class="module-item"><td><a class="struct" href="struct.CookieSession.html" title="actix_session::CookieSession struct">CookieSession</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="actix_session::Session struct">Session</a></td><td class="docblock-short"><p>The high-level interface you use to modify session data.</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.SessionStatus.html" title="actix_session::SessionStatus enum">SessionStatus</a></td><td class="docblock-short"></td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||||
<table><tr class="module-item"><td><a class="enum" href="enum.SessionStatus.html" title="actix_session::SessionStatus enum">SessionStatus</a></td><td class="docblock-short"><p>Status of a <a href="../actix_session/struct.Session.html" title="Session"><code>Session</code></a>.</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.UserSession.html" title="actix_session::UserSession trait">UserSession</a></td><td class="docblock-short"><p>Extraction of a <a href="../actix_session/struct.Session.html" title="Session"><code>Session</code></a> object.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_session" data-search-js="../search-index.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
@ -1 +1 @@
|
||||
initSidebarItems({"enum":[["SessionStatus",""]],"struct":[["CookieSession","Use cookies for session storage."],["Session","The high-level interface you use to modify session data."]],"trait":[["UserSession","Extraction of a [`Session`] object."]]});
|
||||
initSidebarItems({"enum":[["SessionStatus","Status of a [`Session`]."]],"struct":[["CookieSession","Use cookies for session storage."],["Session","The high-level interface you use to modify session data."]],"trait":[["UserSession","Extraction of a [`Session`] object."]]});
|
||||
@ -1,7 +1,7 @@
|
||||
<!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="Use cookies for session storage."><meta name="keywords" content="rust, rustlang, rust-lang, CookieSession"><title>actix_session::CookieSession - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[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" role="button">☰</div><a href='../actix_session/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct CookieSession</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.domain">domain</a><a href="#method.expires_in">expires_in</a><a href="#method.expires_in_time">expires_in_time</a><a href="#method.http_only">http_only</a><a href="#method.lazy">lazy</a><a href="#method.max_age">max_age</a><a href="#method.max_age_time">max_age_time</a><a href="#method.name">name</a><a href="#method.path">path</a><a href="#method.private">private</a><a href="#method.same_site">same_site</a><a href="#method.secure">secure</a><a href="#method.signed">signed</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E">Transform<S, ServiceRequest></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_session</a></p><div id="sidebar-vars" data-name="CookieSession" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_session</a>::<wbr><a class="struct" href="">CookieSession</a></span><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_session/cookie.rs.html#198" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct CookieSession(_);</pre></div><div class="docblock"><p>Use cookies for session storage.</p>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_session</a>::<wbr><a class="struct" href="">CookieSession</a></span><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_session/cookie.rs.html#201" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct CookieSession(_);</pre></div><div class="docblock"><p>Use cookies for session storage.</p>
|
||||
<p><code>CookieSession</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 the session contains more
|
||||
@ -32,31 +32,31 @@ cause troubles when reading cookie, if they are not properly percent encoded.</p
|
||||
.<span class="ident">path</span>(<span class="string">"/"</span>)
|
||||
.<span class="ident">secure</span>(<span class="bool-val">true</span>))
|
||||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/"</span>).<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()));</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_session/cookie.rs.html#200-290" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.signed" class="method"><code>pub fn <a href="#method.signed" class="fnname">signed</a>(key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#204-209" title="goto source code">[src]</a></h4><div class="docblock"><p>Construct new <em>signed</em> <code>CookieSession</code> instance.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_session/cookie.rs.html#203-293" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.signed" class="method"><code>pub fn <a href="#method.signed" class="fnname">signed</a>(key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#207-212" title="goto source code">[src]</a></h4><div class="docblock"><p>Construct new <em>signed</em> <code>CookieSession</code> instance.</p>
|
||||
<p>Panics if key length is less than 32 bytes.</p>
|
||||
</div><h4 id="method.private" class="method"><code>pub fn <a href="#method.private" class="fnname">private</a>(key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#214-219" title="goto source code">[src]</a></h4><div class="docblock"><p>Construct new <em>private</em> <code>CookieSession</code> instance.</p>
|
||||
</div><h4 id="method.private" class="method"><code>pub fn <a href="#method.private" class="fnname">private</a>(key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#217-222" title="goto source code">[src]</a></h4><div class="docblock"><p>Construct new <em>private</em> <code>CookieSession</code> instance.</p>
|
||||
<p>Panics if key length is less than 32 bytes.</p>
|
||||
</div><h4 id="method.path" class="method"><code>pub fn <a href="#method.path" class="fnname">path</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#222-225" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>path</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.name" class="method"><code>pub fn <a href="#method.name" class="fnname">name</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#228-231" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>name</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.domain" class="method"><code>pub fn <a href="#method.domain" class="fnname">domain</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#234-237" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>domain</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.lazy" class="method"><code>pub fn <a href="#method.lazy" class="fnname">lazy</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#243-246" title="goto source code">[src]</a></h4><div class="docblock"><p>When true, prevents adding session cookies to responses until
|
||||
</div><h4 id="method.path" class="method"><code>pub fn <a href="#method.path" class="fnname">path</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#225-228" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>path</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.name" class="method"><code>pub fn <a href="#method.name" class="fnname">name</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#231-234" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>name</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.domain" class="method"><code>pub fn <a href="#method.domain" class="fnname">domain</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, value: S) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#237-240" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>domain</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.lazy" class="method"><code>pub fn <a href="#method.lazy" class="fnname">lazy</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#246-249" title="goto source code">[src]</a></h4><div class="docblock"><p>When true, prevents adding session cookies to responses until
|
||||
the session contains data. Default is <code>false</code>.</p>
|
||||
<p>Useful when trying to comply with laws that require consent for setting cookies.</p>
|
||||
</div><h4 id="method.secure" class="method"><code>pub fn <a href="#method.secure" class="fnname">secure</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#252-255" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>secure</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.secure" class="method"><code>pub fn <a href="#method.secure" class="fnname">secure</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#255-258" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>secure</code> field in the session cookie being built.</p>
|
||||
<p>If the <code>secure</code> field is set, a cookie will only be transmitted when the
|
||||
connection is secure - i.e. <code>https</code></p>
|
||||
</div><h4 id="method.http_only" class="method"><code>pub fn <a href="#method.http_only" class="fnname">http_only</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#258-261" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>http_only</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.same_site" class="method"><code>pub fn <a href="#method.same_site" class="fnname">same_site</a>(self, value: <a class="enum" href="https://docs.rs/cookie/0.14/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#264-267" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>same_site</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.max_age" class="method"><code>pub fn <a href="#method.max_age" class="fnname">max_age</a>(self, seconds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#270-272" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>max-age</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.max_age_time" class="method"><code>pub fn <a href="#method.max_age_time" class="fnname">max_age_time</a>(self, value: Duration) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#275-278" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>max-age</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.expires_in" class="method"><code>pub fn <a href="#method.expires_in" class="fnname">expires_in</a>(self, seconds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#281-283" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>expires</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.expires_in_time" class="method"><code>pub fn <a href="#method.expires_in_time" class="fnname">expires_in_time</a>(self, value: Duration) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#286-289" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>expires</code> field in the session cookie being built.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Transform%3CS%2C%20ServiceRequest%3E" class="impl"><code class="in-band">impl<S, B: 'static> Transform<S, ServiceRequest> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a> <span class="where fmt-newline">where<br> S: Service<ServiceRequest, Response = ServiceResponse<B>>,<br> S::Future: 'static,<br> S::Error: 'static, </span></code><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E" class="anchor"></a><a class="srclink" href="../src/actix_session/cookie.rs.html#292-310" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Response" class="type"><code>type <a href="#associatedtype.Response" class="type">Response</a> = ServiceResponse<B></code></h4><div class='docblock'><p>Responses produced by the service.</p>
|
||||
</div><h4 id="method.http_only" class="method"><code>pub fn <a href="#method.http_only" class="fnname">http_only</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#261-264" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>http_only</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.same_site" class="method"><code>pub fn <a href="#method.same_site" class="fnname">same_site</a>(self, value: <a class="enum" href="https://docs.rs/cookie/0.14/cookie/draft/enum.SameSite.html" title="enum cookie::draft::SameSite">SameSite</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#267-270" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>same_site</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.max_age" class="method"><code>pub fn <a href="#method.max_age" class="fnname">max_age</a>(self, seconds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#273-275" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>max-age</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.max_age_time" class="method"><code>pub fn <a href="#method.max_age_time" class="fnname">max_age_time</a>(self, value: Duration) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#278-281" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>max-age</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.expires_in" class="method"><code>pub fn <a href="#method.expires_in" class="fnname">expires_in</a>(self, seconds: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#284-286" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>expires</code> field in the session cookie being built.</p>
|
||||
</div><h4 id="method.expires_in_time" class="method"><code>pub fn <a href="#method.expires_in_time" class="fnname">expires_in_time</a>(self, value: Duration) -> <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a class="srclink" href="../src/actix_session/cookie.rs.html#289-292" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the <code>expires</code> field in the session cookie being built.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Transform%3CS%2C%20ServiceRequest%3E" class="impl"><code class="in-band">impl<S, B: 'static> Transform<S, ServiceRequest> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a> <span class="where fmt-newline">where<br> S: Service<ServiceRequest, Response = ServiceResponse<B>>,<br> S::Future: 'static,<br> S::Error: 'static, </span></code><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E" class="anchor"></a><a class="srclink" href="../src/actix_session/cookie.rs.html#295-313" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Response" class="type"><code>type <a href="#associatedtype.Response" class="type">Response</a> = ServiceResponse<B></code></h4><div class='docblock'><p>Responses produced by the service.</p>
|
||||
</div><h4 id="associatedtype.Error" class="type"><code>type <a href="#associatedtype.Error" class="type">Error</a> = S::Error</code></h4><div class='docblock'><p>Errors produced by the service.</p>
|
||||
</div><h4 id="associatedtype.InitError" class="type"><code>type <a href="#associatedtype.InitError" class="type">InitError</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><div class='docblock'><p>Errors produced while building a transform service.</p>
|
||||
</div><h4 id="associatedtype.Transform" class="type"><code>type <a href="#associatedtype.Transform" class="type">Transform</a> = CookieSessionMiddleware<S></code></h4><div class='docblock'><p>The <code>TransformService</code> value created by this factory</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="#associatedtype.Future" class="type">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::Transform, Self::InitError>></code></h4><div class='docblock'><p>The future response value.</p>
|
||||
</div><h4 id="method.new_transform" class="method hidden"><code>fn <a href="#method.new_transform" class="fnname">new_transform</a>(&self, service: S) -> Self::Future</code><a class="srclink" href="../src/actix_session/cookie.rs.html#304-309" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
|
||||
</div><h4 id="method.new_transform" class="method hidden"><code>fn <a href="#method.new_transform" class="fnname">new_transform</a>(&self, service: S) -> Self::Future</code><a class="srclink" href="../src/actix_session/cookie.rs.html#307-312" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates and returns a new Transform component, asynchronously</p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_session/struct.CookieSession.html" title="struct actix_session::CookieSession">CookieSession</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!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="The high-level interface you use to modify session data."><meta name="keywords" content="rust, rustlang, rust-lang, Session"><title>actix_session::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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[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" role="button">☰</div><a href='../actix_session/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct Session</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.clear">clear</a><a href="#method.get">get</a><a href="#method.get_changes">get_changes</a><a href="#method.purge">purge</a><a href="#method.remove">remove</a><a href="#method.renew">renew</a><a href="#method.set">set</a><a href="#method.set_session">set_session</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-FromRequest">FromRequest</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_session</a></p><div id="sidebar-vars" data-name="Session" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_session</a>::<wbr><a class="struct" href="">Session</a></span><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_session/lib.rs.html#78" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Session(_);</pre></div><div class="docblock"><p>The high-level interface you use to modify session data.</p>
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[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" role="button">☰</div><a href='../actix_session/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct Session</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.clear">clear</a><a href="#method.entries">entries</a><a href="#method.get">get</a><a href="#method.get_changes">get_changes</a><a href="#method.insert">insert</a><a href="#method.purge">purge</a><a href="#method.remove">remove</a><a href="#method.remove_as">remove_as</a><a href="#method.renew">renew</a><a href="#method.set_session">set_session</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-FromRequest">FromRequest</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><p class="location"><a href="index.html">actix_session</a></p><div id="sidebar-vars" data-name="Session" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">actix_session</a>::<wbr><a class="struct" href="">Session</a></span><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_session/lib.rs.html#84" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Session(_);</pre></div><div class="docblock"><p>The high-level interface you use to modify session data.</p>
|
||||
<p>Session object is obtained with <a href="../actix_session/trait.UserSession.html#tymethod.get_session" title="UserSession::get_session"><code>UserSession::get_session</code></a>. The <a href="../actix_session/trait.UserSession.html" title="UserSession"><code>UserSession</code></a> trait is
|
||||
implemented for <code>HttpRequest</code>, <code>ServiceRequest</code>, and <code>RequestHead</code>.</p>
|
||||
|
||||
@ -12,20 +12,28 @@ implemented for <code>HttpRequest</code>, <code>ServiceRequest</code>, and <code
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">session</span>: <span class="ident">Session</span>) <span class="op">-</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">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="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="ident">session</span>.<span class="ident">insert</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">session</span>.<span class="ident">set</span>(<span class="string">"counter"</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
|
||||
<span class="ident">session</span>.<span class="ident">insert</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>)
|
||||
}</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#122-229" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a><T: <a class="trait" href="https://docs.rs/serde/1.0.125/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>, Error></code><a class="srclink" href="../src/actix_session/lib.rs.html#124-130" title="goto source code">[src]</a></h4><div class="docblock"><p>Get a <code>value</code> from the session.</p>
|
||||
</div><h4 id="method.set" class="method"><code>pub fn <a href="#method.set" class="fnname">set</a><T: <a class="trait" href="https://docs.rs/serde/1.0.125/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error></code><a class="srclink" href="../src/actix_session/lib.rs.html#133-142" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a <code>value</code> from the session.</p>
|
||||
</div><h4 id="method.remove" class="method"><code>pub fn <a href="#method.remove" class="fnname">remove</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code><a class="srclink" href="../src/actix_session/lib.rs.html#145-151" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove value from the session.</p>
|
||||
</div><h4 id="method.clear" class="method"><code>pub fn <a href="#method.clear" class="fnname">clear</a>(&self)</code><a class="srclink" href="../src/actix_session/lib.rs.html#154-160" title="goto source code">[src]</a></h4><div class="docblock"><p>Clear the session.</p>
|
||||
</div><h4 id="method.purge" class="method"><code>pub fn <a href="#method.purge" class="fnname">purge</a>(&self)</code><a class="srclink" href="../src/actix_session/lib.rs.html#163-167" title="goto source code">[src]</a></h4><div class="docblock"><p>Removes session, both client and server side.</p>
|
||||
</div><h4 id="method.renew" class="method"><code>pub fn <a href="#method.renew" class="fnname">renew</a>(&self)</code><a class="srclink" href="../src/actix_session/lib.rs.html#170-175" title="goto source code">[src]</a></h4><div class="docblock"><p>Renews the session key, assigning existing session state to new key.</p>
|
||||
</div><h4 id="method.set_session" class="method"><code>pub fn <a href="#method.set_session" class="fnname">set_session</a>(<br> data: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, <br> req: &mut ServiceRequest<br>)</code><a class="srclink" href="../src/actix_session/lib.rs.html#193-200" title="goto source code">[src]</a></h4><div class="docblock"><p>Adds the given key-value pairs to the session on the request.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#147-295" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a><T: <a class="trait" href="https://docs.rs/serde/1.0.125/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>, Error></code><a class="srclink" href="../src/actix_session/lib.rs.html#149-155" title="goto source code">[src]</a></h4><div class="docblock"><p>Get a <code>value</code> from the session.</p>
|
||||
</div><h4 id="method.entries" class="method"><code>pub fn <a href="#method.entries" class="fnname">entries</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><'_, <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><<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>>></code><a class="srclink" href="../src/actix_session/lib.rs.html#160-162" title="goto source code">[src]</a></h4><div class="docblock"><p>Get all raw key-value data from the session.</p>
|
||||
<p>Note that values are JSON encoded.</p>
|
||||
</div><h4 id="method.insert" class="method"><code>pub fn <a href="#method.insert" class="fnname">insert</a>(<br> &self, <br> key: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> value: impl <a class="trait" href="https://docs.rs/serde/1.0.125/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error></code><a class="srclink" href="../src/actix_session/lib.rs.html#168-182" title="goto source code">[src]</a></h4><div class="docblock"><p>Inserts a key-value pair into the session.</p>
|
||||
<p>Any serializable value can be used and will be encoded as JSON in session data, hence why
|
||||
only a reference to the value is taken.</p>
|
||||
</div><h4 id="method.remove" class="method"><code>pub fn <a href="#method.remove" class="fnname">remove</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class="srclink" href="../src/actix_session/lib.rs.html#187-196" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove value from the session.</p>
|
||||
<p>If present, the JSON encoded value is returned.</p>
|
||||
</div><h4 id="method.remove_as" class="method"><code>pub fn <a href="#method.remove_as" class="fnname">remove_as</a><T: <a class="trait" href="https://docs.rs/serde/1.0.125/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(<br> &self, <br> key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>></code><a class="srclink" href="../src/actix_session/lib.rs.html#202-218" title="goto source code">[src]</a></h4><div class="docblock"><p>Remove value from the session and deserialize.</p>
|
||||
<p>Returns None if key was not present in session. Returns T if deserialization succeeds,
|
||||
otherwise returns un-deserialized JSON string.</p>
|
||||
</div><h4 id="method.clear" class="method"><code>pub fn <a href="#method.clear" class="fnname">clear</a>(&self)</code><a class="srclink" href="../src/actix_session/lib.rs.html#221-228" title="goto source code">[src]</a></h4><div class="docblock"><p>Clear the session.</p>
|
||||
</div><h4 id="method.purge" class="method"><code>pub fn <a href="#method.purge" class="fnname">purge</a>(&self)</code><a class="srclink" href="../src/actix_session/lib.rs.html#231-235" title="goto source code">[src]</a></h4><div class="docblock"><p>Removes session both client and server side.</p>
|
||||
</div><h4 id="method.renew" class="method"><code>pub fn <a href="#method.renew" class="fnname">renew</a>(&self)</code><a class="srclink" href="../src/actix_session/lib.rs.html#238-244" title="goto source code">[src]</a></h4><div class="docblock"><p>Renews the session key, assigning existing session state to new key.</p>
|
||||
</div><h4 id="method.set_session" class="method"><code>pub fn <a href="#method.set_session" class="fnname">set_session</a>(<br> req: &mut ServiceRequest, <br> data: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>><br>)</code><a class="srclink" href="../src/actix_session/lib.rs.html#262-269" title="goto source code">[src]</a></h4><div class="docblock"><p>Adds the given key-value pairs to the session on the request.</p>
|
||||
<p>Values that match keys already existing on the session will be overwritten. Values should
|
||||
already be JSON serialized.</p>
|
||||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||||
@ -33,28 +41,31 @@ already be JSON serialized.</p>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">TestRequest</span>::<span class="ident">default</span>().<span class="ident">to_srv_request</span>();
|
||||
|
||||
<span class="ident">Session</span>::<span class="ident">set_session</span>(
|
||||
<span class="macro">vec</span><span class="macro">!</span>[(<span class="string">"counter"</span>.<span class="ident">to_string</span>(), <span class="ident">serde_json</span>::<span class="ident">to_string</span>(<span class="kw-2">&</span><span class="number">0</span>).<span class="ident">unwrap</span>())],
|
||||
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">req</span>,
|
||||
<span class="macro">vec</span><span class="macro">!</span>[(<span class="string">"counter"</span>.<span class="ident">to_string</span>(), <span class="ident">serde_json</span>::<span class="ident">to_string</span>(<span class="kw-2">&</span><span class="number">0</span>).<span class="ident">unwrap</span>())],
|
||||
);</pre></div>
|
||||
</div><h4 id="method.get_changes" class="method"><code>pub fn <a href="#method.get_changes" class="fnname">get_changes</a><B>(<br> res: &mut ServiceResponse<B><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#202-219" title="goto source code">[src]</a></h4></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-FromRequest" class="impl"><code class="in-band">impl FromRequest for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-FromRequest" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#249-258" title="goto source code">[src]</a></h3><div class="docblock"><p>Extractor implementation for Session type.</p>
|
||||
|
||||
</div><h4 id="method.get_changes" class="method"><code>pub fn <a href="#method.get_changes" class="fnname">get_changes</a><B>(<br> res: &mut ServiceResponse<B><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../actix_session/enum.SessionStatus.html" title="enum actix_session::SessionStatus">SessionStatus</a>, impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#272-285" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns session status and iterator of key-value pairs of changes.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-FromRequest" class="impl"><code class="in-band">impl FromRequest for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-FromRequest" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#317-326" title="goto source code">[src]</a></h3><div class="docblock"><p>Extractor implementation for Session type.</p>
|
||||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">actix_session</span>::<span class="ident">Session</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">session</span>: <span class="ident">Session</span>) <span class="op">-</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="attribute">#[<span class="ident">get</span>(<span class="string">"/"</span>)]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">session</span>: <span class="ident">Session</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="kw">impl</span> <span class="ident">Responder</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">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="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="ident">session</span>.<span class="ident">insert</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">session</span>.<span class="ident">set</span>(<span class="string">"counter"</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
|
||||
<span class="ident">session</span>.<span class="ident">insert</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">let</span> <span class="ident">count</span> <span class="op">=</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="ident">unwrap</span>();
|
||||
<span class="prelude-val">Ok</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Counter: {}"</span>, <span class="ident">count</span>))
|
||||
}</pre></div>
|
||||
</div><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="#associatedtype.Error" class="type">Error</a> = Error</code></h4><div class='docblock'><p>The associated error which can be returned.</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="#associatedtype.Future" class="type">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a>, Error>></code></h4><div class='docblock'><p>Future that resolves to a Self.</p>
|
||||
</div><h4 id="associatedtype.Config" class="type"><code>type <a href="#associatedtype.Config" class="type">Config</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><div class='docblock'><p>Configuration for this extractor.</p>
|
||||
</div><h4 id="method.from_request" class="method hidden"><code>fn <a href="#method.from_request" class="fnname">from_request</a>(req: &HttpRequest, _: &mut Payload) -> Self::Future</code><a class="srclink" href="../src/actix_session/lib.rs.html#255-257" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Create a Self from request parts asynchronously.</p>
|
||||
</div><h4 id="method.from_request" class="method hidden"><code>fn <a href="#method.from_request" class="fnname">from_request</a>(req: &HttpRequest, _: &mut Payload) -> Self::Future</code><a class="srclink" href="../src/actix_session/lib.rs.html#323-325" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Create a Self from request parts asynchronously.</p>
|
||||
</div><h4 id="method.extract" class="method hidden"><code>pub fn <a href="#method.extract" class="fnname">extract</a>(req: &HttpRequest) -> Self::Future</code></h4><div class='docblock hidden'><p>Create a Self from request head asynchronously. <a href="#method.extract">Read more</a></p>
|
||||
</div><h4 id="method.configure" class="method hidden"><code>pub fn <a href="#method.configure" class="fnname">configure</a><F>(f: F) -> Self::Config <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::Config) -> Self::Config, </span></code></h4><div class='docblock hidden'><p>Create and configure config instance.</p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
<!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="Extraction of a [`Session`] object."><meta name="keywords" content="rust, rustlang, rust-lang, UserSession"><title>actix_session::UserSession - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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" role="button">☰</div><a href='../actix_session/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait UserSession</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_session">get_session</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-UserSession-for-HttpRequest">HttpRequest</a><a href="#impl-UserSession-for-RequestHead">RequestHead</a><a href="#impl-UserSession-for-ServiceRequest">ServiceRequest</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">actix_session</a></p><div id="sidebar-vars" data-name="UserSession" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_session</a>::<wbr><a class="trait" href="">UserSession</a></span><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_session/lib.rs.html#81-83" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait UserSession {
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_session</a>::<wbr><a class="trait" href="">UserSession</a></span><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_session/lib.rs.html#87-90" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait UserSession {
|
||||
fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a>;
|
||||
}</pre></div><div class="docblock"><p>Extraction of a <a href="../actix_session/struct.Session.html" title="Session"><code>Session</code></a> object.</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.get_session" class="method"><code>fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#82" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-UserSession-for-HttpRequest" class="impl"><code class="in-band">impl <a class="trait" href="../actix_session/trait.UserSession.html" title="trait actix_session::UserSession">UserSession</a> for HttpRequest</code><a href="#impl-UserSession-for-HttpRequest" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#85-89" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_session" class="method hidden"><code>fn <a href="#method.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#86-88" title="goto source code">[src]</a></h4></div><h3 id="impl-UserSession-for-ServiceRequest" class="impl"><code class="in-band">impl <a class="trait" href="../actix_session/trait.UserSession.html" title="trait actix_session::UserSession">UserSession</a> for ServiceRequest</code><a href="#impl-UserSession-for-ServiceRequest" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#91-95" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_session-1" class="method hidden"><code>fn <a href="#method.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#92-94" title="goto source code">[src]</a></h4></div><h3 id="impl-UserSession-for-RequestHead" class="impl"><code class="in-band">impl <a class="trait" href="../actix_session/trait.UserSession.html" title="trait actix_session::UserSession">UserSession</a> for RequestHead</code><a href="#impl-UserSession-for-RequestHead" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#97-101" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_session-2" class="method hidden"><code>fn <a href="#method.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#98-100" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/actix_session/trait.UserSession.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_session" data-search-js="../search-index.js"></div>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.get_session" class="method"><code>fn <a href="#tymethod.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#89" title="goto source code">[src]</a></h3><div class="docblock"><p>Extract the <a href="../actix_session/struct.Session.html" title="Session"><code>Session</code></a> object</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-UserSession-for-HttpRequest" class="impl"><code class="in-band">impl <a class="trait" href="../actix_session/trait.UserSession.html" title="trait actix_session::UserSession">UserSession</a> for HttpRequest</code><a href="#impl-UserSession-for-HttpRequest" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#92-96" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_session" class="method hidden"><code>fn <a href="#method.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#93-95" title="goto source code">[src]</a></h4></div><h3 id="impl-UserSession-for-ServiceRequest" class="impl"><code class="in-band">impl <a class="trait" href="../actix_session/trait.UserSession.html" title="trait actix_session::UserSession">UserSession</a> for ServiceRequest</code><a href="#impl-UserSession-for-ServiceRequest" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#98-102" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_session-1" class="method hidden"><code>fn <a href="#method.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#99-101" title="goto source code">[src]</a></h4></div><h3 id="impl-UserSession-for-RequestHead" class="impl"><code class="in-band">impl <a class="trait" href="../actix_session/trait.UserSession.html" title="trait actix_session::UserSession">UserSession</a> for RequestHead</code><a href="#impl-UserSession-for-RequestHead" class="anchor"></a><a class="srclink" href="../src/actix_session/lib.rs.html#104-108" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_session-2" class="method hidden"><code>fn <a href="#method.get_session" class="fnname">get_session</a>(&self) -> <a class="struct" href="../actix_session/struct.Session.html" title="struct actix_session::Session">Session</a></code><a class="srclink" href="../src/actix_session/lib.rs.html#105-107" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/actix_session/trait.UserSession.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_session" data-search-js="../search-index.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
Reference in New Issue
Block a user