actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 16:02:59 +01:00
Code Issues Releases Wiki Activity
9cc31cd655
actix-extras/actix_session/struct.SessionMiddleware.html

110 lines
48 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 7d932cd540e422a90f5d6c1771ed74264c740819 🚀
2022-08-28 21:33:30 +02:00
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A middleware for session management in Actix Web applications."><meta name="keywords" content="rust, rustlang, rust-lang, SessionMiddleware"><title>SessionMiddleware in actix_session - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../actix_session/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../actix_session/index.html"><div class="logo-container">
Deploying to gh-pages from @ fb8a814acb3166ac6c44a49b7e8895cc00e8c564 🚀
2022-10-15 13:40:31 +02:00
<img src="https://actix.rs/img/logo.png" alt="logo"></div></a><h2 class="location"><a href="#">SessionMiddleware</a></h2><div class="sidebar-elems"><section><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.builder">builder</a></li><li><a href="#method.new">new</a></li></ul><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-SessionMiddleware%3CStore%3E">Clone</a></li><li><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E-for-SessionMiddleware%3CStore%3E">Transform&lt;S, ServiceRequest&gt;</a></li></ul><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-SessionMiddleware%3CStore%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-SessionMiddleware%3CStore%3E">!Send</a></li><li><a href="#impl-Sync-for-SessionMiddleware%3CStore%3E">!Sync</a></li><li><a href="#impl-Unpin-for-SessionMiddleware%3CStore%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-SessionMiddleware%3CStore%3E">UnwindSafe</a></li></ul><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-SessionMiddleware%3CStore%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-SessionMiddleware%3CStore%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-SessionMiddleware%3CStore%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-SessionMiddleware%3CStore%3E">From&lt;T&gt;</a></li><li><a href="#impl-Instrument-for-SessionMiddleware%3CStore%3E">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-SessionMiddleware%3CStore%3E">Into&lt;U&gt;</a></li><li><a href="#impl-Same%3CT%3E-for-SessionMiddleware%3CStore%3E">Same&lt;T&gt;</a></li><li><a href="#impl-ToOwned-for-SessionMiddleware%3CStore%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-SessionMiddleware%3CStore%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-SessionMiddleware%3CStore%3E">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-SessionMiddleware%3CStore%3E">VZip&lt;V&gt;</a></li><li><a href="#impl-WithSubscriber-for-SessionMiddleware%3CStore%3E">WithSubscriber</a></li></ul></section><h2 class="location"><a href="index.html">In actix_session</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../actix_session/index.html">
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="index.html">actix_session</a>::<wbr><a class="struct" href="#">SessionMiddleware</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/actix_session/middleware.rs.html#117-120">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct SessionMiddleware&lt;Store:&nbsp;<a class="trait" href="storage/trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a>&gt; { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A middleware for session management in Actix Web applications.</p>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<p><a href="struct.SessionMiddleware.html" title="SessionMiddleware"><code>SessionMiddleware</code></a> takes care of a few jobs:</p>
<ul>
<li>Instructs the session storage backend to create/update/delete/retrieve the state attached to
a session according to its status and the operations that have been performed against it;</li>
<li>Set/remove a cookie, on the client side, to enable a user to be consistently associated with
the same session across multiple HTTP requests.</li>
</ul>
<p>Use <a href="struct.SessionMiddleware.html#method.new" title="SessionMiddleware::new"><code>SessionMiddleware::new</code></a> to initialize the session framework using the default parameters.
To create a new instance of <a href="struct.SessionMiddleware.html" title="SessionMiddleware"><code>SessionMiddleware</code></a> you need to provide:</p>
<ul>
<li>an instance of the session storage backend you wish to use (i.e. an implementation of
Deploying to gh-pages from @ d11a2723841d1eb376c1fbfbda8f432ad2d7d9c6 🚀
2022-05-18 11:58:19 +02:00
<a href="storage/trait.SessionStore.html" title="SessionStore"><code>SessionStore</code></a>);</li>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<li>a secret key, to sign or encrypt the content of client-side session cookie.</li>
</ul>
Deploying to gh-pages from @ a325f5dd02bb19e39dcdde166d333f4a1258f418 🚀
2022-08-09 02:06:13 +02:00
<h2 id="how-did-we-choose-defaults"><a href="#how-did-we-choose-defaults">How did we choose defaults?</a></h2>
<p>You should not regret adding <code>actix-session</code> to your dependencies and going to production using
the default configuration. That is why, when in doubt, we opt to use the most secure option for
each configuration parameter.</p>
<p>We expose knobs to change the default to suit your needs—i.e., if you know what you are doing,
we will not stop you. But being a subject-matter expert should not be a requirement to deploy
reasonably secure implementation of sessions.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{web, App, HttpServer, HttpResponse, Error};
<span class="kw">use </span>actix_session::{Session, SessionMiddleware, storage::RedisActorSessionStore};
<span class="kw">use </span>actix_web::cookie::Key;
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="comment">// The secret key would usually be read from a configuration file/environment variables.
</span><span class="kw">fn </span>get_secret_key() -&gt; Key {
<span class="comment">// [...]
</span>}
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="attribute">#[actix_web::main]
</span><span class="kw">async fn </span>main() -&gt; std::io::Result&lt;()&gt; {
<span class="kw">let </span>secret_key = get_secret_key();
<span class="kw">let </span>redis_connection_string = <span class="string">&quot;127.0.0.1:6379&quot;</span>;
HttpServer::new(<span class="kw">move </span>||
App::new()
<span class="comment">// Add session management to your application using Redis for session state storage
</span>.wrap(
SessionMiddleware::new(
RedisActorSessionStore::new(redis_connection_string),
secret_key.clone()
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
)
)
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.default_service(web::to(|| HttpResponse::Ok())))
.bind((<span class="string">&quot;127.0.0.1&quot;</span>, <span class="number">8080</span>))<span class="question-mark">?
</span>.run()
.<span class="kw">await
</span>}</code></pre></div>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<p>If you want to customise use <a href="struct.SessionMiddleware.html#method.builder"><code>builder</code></a> instead of <a href="struct.SessionMiddleware.html#method.new"><code>new</code></a>:</p>
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{App, cookie::{Key, time}, Error, HttpResponse, HttpServer, web};
<span class="kw">use </span>actix_session::{Session, SessionMiddleware, storage::RedisActorSessionStore};
<span class="kw">use </span>actix_session::config::PersistentSession;
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="comment">// The secret key would usually be read from a configuration file/environment variables.
</span><span class="kw">fn </span>get_secret_key() -&gt; Key {
<span class="comment">// [...]
</span>}
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="attribute">#[actix_web::main]
</span><span class="kw">async fn </span>main() -&gt; std::io::Result&lt;()&gt; {
<span class="kw">let </span>secret_key = get_secret_key();
<span class="kw">let </span>redis_connection_string = <span class="string">&quot;127.0.0.1:6379&quot;</span>;
HttpServer::new(<span class="kw">move </span>||
App::new()
<span class="comment">// Customise session length!
</span>.wrap(
SessionMiddleware::builder(
RedisActorSessionStore::new(redis_connection_string),
secret_key.clone()
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
)
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.session_lifecycle(
PersistentSession::default()
.session_ttl(time::Duration::days(<span class="number">5</span>))
Deploying to gh-pages from @ c2f068db668e660e2ab3e55793c9d493c078ff5c 🚀
2022-07-03 22:20:50 +02:00
)
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.build(),
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
)
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
.default_service(web::to(|| HttpResponse::Ok())))
.bind((<span class="string">&quot;127.0.0.1&quot;</span>, <span class="number">8080</span>))<span class="question-mark">?
</span>.run()
.<span class="kw">await
</span>}</code></pre></div>
Deploying to gh-pages from @ fb8a814acb3166ac6c44a49b7e8895cc00e8c564 🚀
2022-10-15 13:40:31 +02:00
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/middleware.rs.html#122-150">source</a><a href="#impl-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;Store:&nbsp;<a class="trait" href="storage/trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a>&gt; <a class="struct" href="struct.SessionMiddleware.html" title="struct actix_session::SessionMiddleware">SessionMiddleware</a>&lt;Store&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/actix_session/middleware.rs.html#130-132">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(store: Store, key: <a class="struct" href="https://docs.rs/cookie/0.16/cookie/secure/key/struct.Key.html" title="struct cookie::secure::key::Key">Key</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Use <a href="struct.SessionMiddleware.html#method.new" title="SessionMiddleware::new"><code>SessionMiddleware::new</code></a> to initialize the session framework using the default
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
parameters.</p>
<p>To create a new instance of <a href="struct.SessionMiddleware.html" title="SessionMiddleware"><code>SessionMiddleware</code></a> you need to provide:</p>
<ul>
<li>an instance of the session storage backend you wish to use (i.e. an implementation of
Deploying to gh-pages from @ a325f5dd02bb19e39dcdde166d333f4a1258f418 🚀
2022-08-09 02:06:13 +02:00
<a href="storage/trait.SessionStore.html" title="SessionStore"><code>SessionStore</code></a>);</li>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<li>a secret key, to sign or encrypt the content of client-side session cookie.</li>
</ul>
Deploying to gh-pages from @ 7d932cd540e422a90f5d6c1771ed74264c740819 🚀
2022-08-28 21:33:30 +02:00
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.builder" class="method has-srclink"><a class="srclink rightside" href="../src/actix_session/middleware.rs.html#140-142">source</a><h4 class="code-header">pub fn <a href="#method.builder" class="fnname">builder</a>(store: Store, key: <a class="struct" href="https://docs.rs/cookie/0.16/cookie/secure/key/struct.Key.html" title="struct cookie::secure::key::Key">Key</a>) -&gt; <a class="struct" href="config/struct.SessionMiddlewareBuilder.html" title="struct actix_session::config::SessionMiddlewareBuilder">SessionMiddlewareBuilder</a>&lt;Store&gt;</h4></section></summary><div class="docblock"><p>A fluent API to configure <a href="struct.SessionMiddleware.html" title="SessionMiddleware"><code>SessionMiddleware</code></a>.</p>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<p>It takes as input the two required inputs to create a new instance of <a href="struct.SessionMiddleware.html" title="SessionMiddleware"><code>SessionMiddleware</code></a>:</p>
<ul>
<li>an instance of the session storage backend you wish to use (i.e. an implementation of
Deploying to gh-pages from @ a325f5dd02bb19e39dcdde166d333f4a1258f418 🚀
2022-08-09 02:06:13 +02:00
<a href="storage/trait.SessionStore.html" title="SessionStore"><code>SessionStore</code></a>);</li>
Deploying to gh-pages from @ 7e6335a09fa21302cec29904543d707b5da867a3 🚀
2022-03-06 00:25:11 +01:00
<li>a secret key, to sign or encrypt the content of client-side session cookie.</li>
</ul>
Deploying to gh-pages from @ fb8a814acb3166ac6c44a49b7e8895cc00e8c564 🚀
2022-10-15 13:40:31 +02:00
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/middleware.rs.html#116">source</a><a href="#impl-Clone-for-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;Store:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="storage/trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a>&gt; <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="struct" href="struct.SessionMiddleware.html" title="struct actix_session::SessionMiddleware">SessionMiddleware</a>&lt;Store&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_session/middleware.rs.html#116">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.SessionMiddleware.html" title="struct actix_session::SessionMiddleware">SessionMiddleware</a>&lt;Store&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><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#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Transform%3CS%2C%20ServiceRequest%3E-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_session/middleware.rs.html#152-172">source</a><a href="#impl-Transform%3CS%2C%20ServiceRequest%3E-for-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;S, B, Store&gt; Transform&lt;S, ServiceRequest&gt; for <a class="struct" href="struct.SessionMiddleware.html" title="struct actix_session::SessionMiddleware">SessionMiddleware</a>&lt;Store&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: Service&lt;ServiceRequest, Response = ServiceResponse&lt;B&gt;, Error = Error&gt; + 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;S::Future: 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: MessageBody + 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;Store: <a class="trait" href="storage/trait.SessionStore.html" title="trait actix_session::storage::SessionStore">SessionStore</a> + 'static,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Response" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Response" class="anchor"></a><h4 class="code-header">type <a
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a> <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
Deploying to gh-pages from @ d46ee464e01779ef780758c74248815ab81572ea 🚀
2022-02-18 04:35:44 +01:00
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
Deploying to gh-pages from @ fb8a814acb3166ac6c44a49b7e8895cc00e8c564 🚀
2022-10-15 13:40:31 +02:00
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Same%3CT%3E-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/typenum/1.15.0/src/typenum/type_operators.rs.html#34">source</a><a href="#impl-Same%3CT%3E-for-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html" title="trait typenum::type_operators::Same">Same</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a href="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html#associatedtype.Output" class="associatedtype">Output</a> = T</h4></section></summary><div class='docblock'>Should always be <code>Self</code></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83">source</a><a href="#impl-ToOwned-for-SessionMiddleware%3CStore%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-SessionMiddleware%3CStore%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-SessionM
<a href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
<a href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_session" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (bf15a9e52 2022-10-14)" ></div></body></html>
Reference in New Issue Copy Permalink