<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A verified user identity. It can be used as a request extractor."><metaname="keywords"content="rust, rustlang, rust-lang, Identity"><title>Identity in actix_identity - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-ef244fc9943488f7.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../static.files/light-c11f492748536797.css"><linkrel="stylesheet"disabledhref="../static.files/dark-a78f946771c40031.css"><linkrel="stylesheet"disabledhref="../static.files/ayu-70b683d68cb31790.css"><scriptid="default-settings"></script><scriptsrc="../static.files/storage-d43fa987303ecbbb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-0dede64717b247ca.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-201a7e04dc4c6fce.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../actix_identity/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></div></a><h2></h2></nav><navclass="sidebar"><aclass="sidebar-logo"href="../actix_identity/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></div></a><h2class="location"><ahref="#">Identity</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block"><li><ahref="#method.id">id</a></li><li><ahref="#method.login">login</a></li><li><ahref="#method.logout">logout</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-FromRequest-for-Identity">FromRequest</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-Identity">!RefUnwindSafe</a></li><li><ahref="#impl-Send-for-Identity">!Send</a></li><li><ahref="#impl-Sync-for-Identity">!Sync</a></li><li><ahref="#impl-Unpin-for-Identity">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-Identity">!UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block"><li><ahref="#impl-Any-for-Identity">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-Identity">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-Identity">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-Identity">From<T></a></li><li><ahref="#impl-Instrument-for-Identity">Instrument</a></li><li><ahref=
</div></details><h2id="implementations"class="small-section-header">Implementations<ahref="#implementations"class="anchor"></a></h2><divid="implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Identity"class="impl has-srclink"><aclass="srclink rightside"href="../src/actix_identity/identity.rs.html#112-232">source</a><ahref="#impl-Identity"class="anchor"></a><h3class="code-header">impl <aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.id"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_identity/identity.rs.html#129-133">source</a><h4class="code-header">pub fn <ahref="#method.id"class="fnname">id</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>, <aclass="struct"href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html"title="struct anyhow::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Return the user id associated to the current session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.login"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_identity/identity.rs.html#152-164">source</a><h4class="code-header">pub fn <ahref="#method.login"class="fnname">login</a>(ext: &Extensions, id: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self, <aclass="struct"href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html"title="struct anyhow::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Attach a valid user identity to the current session.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.logout"class="method has-srclink"><aclass="srclink rightside"href="../src/actix_identity/identity.rs.html#186-201">source</a><h4class="code-header">pub fn <ahref="#method.logout"class="fnname">logout</a>(self)</h4></section></summary><divclass="docblock"><p>Remove the user identity from the current session.</p>
<p>After <code>logout</code> has been called, the user will no longer be able to access routes that
require a valid <ahref="struct.Identity.html"title="Identity"><code>Identity</code></a>.</p>
<p>The behaviour on logout is determined by <ahref="config/struct.IdentityMiddlewareBuilder.html#method.logout_behaviour"><code>IdentityMiddlewareBuilder::logout_behaviour</code></a>.</p>
</div><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <aclass="associatedtype">Error</a> = Error</h4></section></summary><divclass='docblock'>The associated error which can be returned.</div></details><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Future"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Future"class="anchor"></a><h4class="code-header">type <aclass="associatedtype">Future</a> = Ready<<aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a>, <<aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a> as FromRequest>::Error>></h4></section></summary><divclass='docblock'>Future that resolves to a <code>Self</code>. <a>Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from_request"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/actix_identity/identity.rs.html#255-264">source</a><ahref="#method.from_request"class="anchor"></a><h4class="code-header">fn <aclass="fnname">from_request</a>(req: &HttpRequest, _: &mut Payload) -> Self::Future</h4></section></summary><divclass='docblock'>Create a <code>Self</code> from request parts asynchronously.</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.extract"class="method trait-impl has-srclink"><ahref="#method.extract"class="anchor"></a><h4class="code-header">fn <aclass="fnname">extract</a>(req: &HttpRequest) -> Self::Future</h4></section></summary><divclass='docblock'>Create a <code>Self</code> from request head asynchronously. <a>Read more</a></div></details></div></details></div><h2id="synthetic-implementations"class="small-section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor"></a></h2><divid="synthetic-implementations-list"><sectionid="impl-RefUnwindSafe-for-Identity"class="impl has-srclink"><ahref="#impl-RefUnwindSafe-for-Identity"class="anchor"></a><h3class="code-header">impl !<aclass="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 <aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a></h3></section><sectionid="impl-Send-for-Identity"class="impl has-srclink"><ahref="#impl-Send-for-Identity"class="anchor"></a><h3class="code-header">impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a></h3></section><sectionid="impl-Sync-for-Identity"class="impl has-srclink"><ahref="#impl-Sync-for-Identity"class="anchor"></a><h3class="code-header">impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a></h3></section><sectionid="impl-Unpin-for-Identity"class="impl has-srclink"><ahref="#impl-Unpin-for-Identity"class="anchor"></a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a> for <aclass="struct"href="struct.Identity.html"title="struct actix_identity::Identity">Identity</a></h3></section><sectionid="impl-UnwindSafe-for-Identity"class="impl has-srclink"><ahref="#impl-UnwindSafe-for-Identity"class="anchor"></a><h3class="code-header">impl !<aclass="trait"href=
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-Identity"class="impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><ahref="#impl-Instrument-for-Identity"class="anchor"></a><h3class="code-header">impl<T><aclass="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><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="WithDispatch"><code>WithDispatch</code></a> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><ahref="#method.with_current_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fnname">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a