actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 07:53:00 +01:00
Code Issues Releases Wiki Activity
e457bbe8e7
actix-extras/actix_identity/struct.Identity.html

120 lines
35 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ actix/actix-extras@373a89a97813e2e53b3d4a1abffc16d0b8308714 🚀
2023-11-03 21:03:30 +01:00
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A verified user identity. It can be used as a request extractor."><title>Identity in actix_identity - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_identity" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (a2f5f9691 2023-11-02)" data-channel="nightly" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.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="logo-container" href="../actix_identity/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_identity/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_identity/index.html">actix_identity</a><span class="version">0.6.0</span></h2></div><h2 class="location"><a href="#">Identity</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.id">id</a></li><li><a href="#method.login">login</a></li><li><a href="#method.logout">logout</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-FromRequest-for-Identity">FromRequest</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Identity">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Identity">!Send</a></li><li><a href="#impl-Sync-for-Identity">!Sync</a></li><li><a href="#impl-UnwindSafe-for-Identity">!UnwindSafe</a></li><li><a href="#impl-Unpin-for-Identity">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<p>The lifecycle of a user identity is tied to the lifecycle of the underlying session. If the
session is destroyed (e.g. the session expired), the user identity will be forgotten, de-facto
forcing a user log out.</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::{
get, post, Responder, HttpRequest, HttpMessage, HttpResponse
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
};
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
<span class="kw">use </span>actix_identity::Identity;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[get(<span class="string">&quot;/&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>index(user: <span class="prelude-ty">Option</span>&lt;Identity&gt;) -&gt; <span class="kw">impl </span>Responder {
<span class="kw">if let </span><span class="prelude-val">Some</span>(user) = user {
<span class="macro">format!</span>(<span class="string">&quot;Welcome! {}&quot;</span>, user.id().unwrap())
} <span class="kw">else </span>{
<span class="string">&quot;Welcome Anonymous!&quot;</span>.to_owned()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
}
}
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[post(<span class="string">&quot;/login&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>login(request: HttpRequest) -&gt; <span class="kw">impl </span>Responder {
Identity::login(<span class="kw-2">&amp;</span>request.extensions(), <span class="string">&quot;User1&quot;</span>.into());
HttpResponse::Ok()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
}
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[post(<span class="string">&quot;/logout&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>logout(user: Identity) -&gt; <span class="kw">impl </span>Responder {
user.logout();
HttpResponse::Ok()
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
}</code></pre></div>
<h2 id="extractor-behaviour"><a href="#extractor-behaviour">Extractor Behaviour</a></h2>
<p>What happens if you try to extract an <code>Identity</code> out of a request that does not have a valid
identity attached? The API will return a <code>401 UNAUTHORIZED</code> to the caller.</p>
<p>If you want to customise this behaviour, consider extracting <code>Option&lt;Identity&gt;</code> or
<code>Result&lt;Identity, actix_web::Error&gt;</code> instead of a bare <code>Identity</code>: you will then be fully in
control of the error path.</p>
<h3 id="examples-1"><a href="#examples-1">Examples</a></h3>
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::{http::header::LOCATION, get, HttpResponse, Responder};
<span class="kw">use </span>actix_identity::Identity;
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[get(<span class="string">&quot;/&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>index(user: <span class="prelude-ty">Option</span>&lt;Identity&gt;) -&gt; <span class="kw">impl </span>Responder {
<span class="kw">if let </span><span class="prelude-val">Some</span>(user) = user {
HttpResponse::Ok().finish()
} <span class="kw">else </span>{
<span class="comment">// Redirect to login page if unauthenticated
</span>HttpResponse::TemporaryRedirect()
.insert_header((LOCATION, <span class="string">&quot;/login&quot;</span>))
.finish()
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
}
}</code></pre></div>
Deploying to gh-pages from @ aaedb9c62542204732ac14a7f339b74ff8337e6c 🚀
2023-09-16 01:32:28 +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="toggle implementors-toggle" open><summary><section id="impl-Identity" class="impl"><a class="src rightside" href="../src/actix_identity/identity.rs.html#113-236">source</a><a href="#impl-Identity" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.id" class="method"><a class="src rightside" href="../src/actix_identity/identity.rs.html#130-135">source</a><h4 class="code-header">pub fn <a href="#method.id" class="fn">id</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></summary><div class="docblock"><p>Return the user id associated to the current session.</p>
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
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::{get, Responder};
<span class="kw">use </span>actix_identity::Identity;
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[get(<span class="string">&quot;/&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>index(user: <span class="prelude-ty">Option</span>&lt;Identity&gt;) -&gt; <span class="kw">impl </span>Responder {
<span class="kw">if let </span><span class="prelude-val">Some</span>(user) = user {
<span class="macro">format!</span>(<span class="string">&quot;Welcome! {}&quot;</span>, user.id().unwrap())
} <span class="kw">else </span>{
<span class="string">&quot;Welcome Anonymous!&quot;</span>.to_owned()
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
}
}</code></pre></div>
Deploying to gh-pages from @ aaedb9c62542204732ac14a7f339b74ff8337e6c 🚀
2023-09-16 01:32:28 +02:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.login" class="method"><a class="src rightside" href="../src/actix_identity/identity.rs.html#154-166">source</a><h4 class="code-header">pub fn <a href="#method.login" class="fn">login</a>(ext: &amp;Extensions, id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="error/struct.LoginError.html" title="struct actix_identity::error::LoginError">LoginError</a>&gt;</h4></section></summary><div class="docblock"><p>Attach a valid user identity to the current session.</p>
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<p>This method should be called after you have successfully authenticated the user. After
<code>login</code> has been called, the user will be able to access all routes that require a valid
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
<a href="struct.Identity.html" title="struct actix_identity::Identity"><code>Identity</code></a>.</p>
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
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::{post, Responder, HttpRequest, HttpMessage, HttpResponse};
<span class="kw">use </span>actix_identity::Identity;
Deploying to gh-pages from @ 23912afd492a43e41563d85bc3a8a7b408423d95 🚀
2021-03-23 06:07:49 +01:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[post(<span class="string">&quot;/login&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>login(request: HttpRequest) -&gt; <span class="kw">impl </span>Responder {
Identity::login(<span class="kw-2">&amp;</span>request.extensions(), <span class="string">&quot;User1&quot;</span>.into());
HttpResponse::Ok()
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
}</code></pre></div>
Deploying to gh-pages from @ aaedb9c62542204732ac14a7f339b74ff8337e6c 🚀
2023-09-16 01:32:28 +02:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.logout" class="method"><a class="src rightside" href="../src/actix_identity/identity.rs.html#188-203">source</a><h4 class="code-header">pub fn <a href="#method.logout" class="fn">logout</a>(self)</h4></section></summary><div class="docblock"><p>Remove the user identity from the current session.</p>
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<p>After <code>logout</code> has been called, the user will no longer be able to access routes that
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
require a valid <a href="struct.Identity.html" title="struct actix_identity::Identity"><code>Identity</code></a>.</p>
<p>The behaviour on logout is determined by <a href="config/struct.IdentityMiddlewareBuilder.html#method.logout_behaviour" title="method actix_identity::config::IdentityMiddlewareBuilder::logout_behaviour"><code>IdentityMiddlewareBuilder::logout_behaviour</code></a>.</p>
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
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::{post, Responder, HttpResponse};
<span class="kw">use </span>actix_identity::Identity;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[post(<span class="string">&quot;/logout&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>logout(user: Identity) -&gt; <span class="kw">impl </span>Responder {
user.logout();
HttpResponse::Ok()
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
}</code></pre></div>
Deploying to gh-pages from @ aaedb9c62542204732ac14a7f339b74ff8337e6c 🚀
2023-09-16 01:32:28 +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="toggle implementors-toggle" open><summary><section id="impl-FromRequest-for-Identity" class="impl"><a class="src rightside" href="../src/actix_identity/identity.rs.html#254-269">source</a><a href="#impl-FromRequest-for-Identity" class="anchor">§</a><h3 class="code-header">impl FromRequest for <a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section></summary><div class="docblock"><p>Extractor implementation for <a href="struct.Identity.html" title="struct actix_identity::Identity"><code>Identity</code></a>.</p>
Deploying to gh-pages from @ b1cea6479538e5c66b577f13ce686511817f5745 🚀
2022-07-09 20:02:47 +02:00
<h4 id="examples-5"><a href="#examples-5">Examples</a></h4>
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::{get, Responder};
<span class="kw">use </span>actix_identity::Identity;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 10:33:31 +01:00
<span class="attr">#[get(<span class="string">&quot;/&quot;</span>)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 19:10:06 +02:00
</span><span class="kw">async fn </span>index(user: <span class="prelude-ty">Option</span>&lt;Identity&gt;) -&gt; <span class="kw">impl </span>Responder {
<span class="kw">if let </span><span class="prelude-val">Some</span>(user) = user {
<span class="macro">format!</span>(<span class="string">&quot;Welcome! {}&quot;</span>, user.id().unwrap())
} <span class="kw">else </span>{
<span class="string">&quot;Welcome Anonymous!&quot;</span>.to_owned()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
}
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
}</code></pre></div>
Deploying to gh-pages from @ actix/actix-extras@4761826616b6ec63155d56c693f88527e92185b7 🚀
2023-10-12 11:05:09 +02:00
</div><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = Error</h4></section></summary><div class='docblock'>The associated error which can be returned.</div></details><details class="toggle" open><summary><section id="associatedtype.Future" class="associatedtype trait-impl"><a href="#associatedtype.Future" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Future</a> = Ready&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, &lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a> as FromRequest&gt;::Error&gt;&gt;</h4></section></summary><div class='docblock'>Future that resolves to a <code>Self</code>. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.from_request" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity.rs.html#259-268">source</a><a href="#method.from_request" class="anchor">§</a><h4 class="code-header">fn <a class="fn">from_request</a>(req: &amp;HttpRequest, _: &amp;mut Payload) -&gt; Self::Future</h4></section></summary><div class='docblock'>Create a <code>Self</code> from request parts asynchronously.</div></details><details class="toggle method-toggle" open><summary><section id="method.extract" class="method trait-impl"><a href="#method.extract" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extract</a>(req: &amp;HttpRequest) -&gt; Self::Future</h4></section></summary><div class='docblock'>Create a <code>Self</code> from request head asynchronously. <a>Read more</a></div></details></div></details></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"><section id="impl-RefUnwindSafe-for-Identity" class="impl"><a href="#impl-RefUnwindSafe-for-Identity" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section><section id="impl-Send-for-Identity" class="impl"><a href="#impl-Send-for-Identity" class="anchor">§</a><h3 class="code-header">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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section><section id="impl-Sync-for-Identity" class="impl"><a href="#impl-Sync-for-Identity" class="anchor">§</a><h3 class="code-header">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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section><section id="impl-Unpin-for-Identity" class="impl"><a href="#impl-Unpin-for-Identity" class="anchor">§</a><h3 class="code-header">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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section><section id="impl-UnwindSafe-for-Identity" class="impl"><a href="#impl-UnwindSafe-for-Identity" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">
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></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#136">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<span class="where fmt-newline">where
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<span class="where fmt-newline">where
Deploying to gh-pages from @ actix/actix-extras@4bad825456f81e8e621bda912f96a33e80e29832 🚀
2023-10-16 21:09:07 +02:00
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; Instrument for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a class="fn">instrument</a>(self, span: Span) -&gt; Instrumented&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a class="fn">in_current_span</a>(self) -&gt; Instrumented&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="super::Span::current()">current</a> <a href="crate::Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" 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
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="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#756">source</a><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="fn">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
Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 21:53:05 +01:00
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
Deploying to gh-pages from @ actix/actix-extras@471f07e27fd69ef500d2e45e7cdb81bce40c24d2 🚀
2023-11-03 20:56:25 +01:00
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Same-for-T" class="impl"><a class="src rightside" href="https://docs.rs/typenum/1.17.0/src/typenum/type_operators.rs.html#34">source</a><a href="#impl-Same-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html" title="trait typenum::type_operators::Same">Same</a> for T</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://docs.rs/typenum/1.17.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="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" 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.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<span class="where fmt-newline">where
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" 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.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<span class="where fmt-newline">where
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;V, T&gt; VZip&lt;V&gt; for T<span class="where fmt-newline">where
Deploying to gh-pages from @ actix/actix-extras@4bad825456f81e8e621bda912f96a33e80e29832 🚀
2023-10-16 21:09:07 +02:00
V: MultiLane&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a href="#method.vzip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">vzip</a>(self) -&gt; V</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; WithSubscriber for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_subscriber</a>&lt;S&gt;(self, subscriber: S) -&gt; WithDispatch&lt;Self&gt;<span class="where fmt-newline">where
Deploying to gh-pages from @ aaedb9c62542204732ac14a7f339b74ff8337e6c 🚀
2023-09-16 01:32:28 +02:00
S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;Dispatch&gt;,</span></h4></section></summary><div class='docblock'>Attaches the provided <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
Deploying to gh-pages from @ actix/actix-extras@4bad825456f81e8e621bda912f96a33e80e29832 🚀
2023-10-16 21:09:07 +02:00
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_current_subscriber</a>(self) -&gt; WithDispatch&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="crate::dispatcher#setting-the-default-subscriber">default</a> <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details></div></details></div></section></div></main></body></html>
Reference in New Issue Copy Permalink