mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-24 07:53:00 +01:00
5 lines
10 KiB
HTML
5 lines
10 KiB
HTML
<!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="Helper trait to retrieve an [`Identity`] instance from various `actix-web`’s types."><meta name="keywords" content="rust, rustlang, rust-lang, IdentityExt"><title>IdentityExt in actix_identity - 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="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[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">☰</button><a class="sidebar-logo" href="../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">IdentityExt</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.get_identity">get_identity</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-IdentityExt-for-GuardContext%3C%27a%3E">GuardContext<'a></a></li><li><a href="#impl-IdentityExt-for-HttpRequest">HttpRequest</a></li><li><a href="#impl-IdentityExt-for-ServiceRequest">ServiceRequest</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In actix_identity</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../actix_identity/index.html"><img class="rust-logo" src="../rust-logo.svg" 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"><span class="in-band">Trait <a href="index.html">actix_identity</a>::<wbr><a class="trait" href="#">IdentityExt</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></span></h1><span class="out-of-band"><a class="srclink" href="../src/actix_identity/identity_ext.rs.html#6-9">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait IdentityExt {
|
||
fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.62/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper trait to retrieve an <a href="struct.Identity.html" title="Identity"><code>Identity</code></a> instance from various <code>actix-web</code>’s types.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.get_identity" class="method has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#8">source</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.62/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></div></summary><div class="docblock"><p>Retrieve the identity attached to the current session, if available.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-HttpRequest" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#11-15">source</a><a href="#impl-IdentityExt-for-HttpRequest" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for HttpRequest</h3></section></summary><div class="impl-items"><section id="method.get_identity" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#12-14">source</a><a href="#method.get_identity" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.62/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-ServiceRequest" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#17-21">source</a><a href="#impl-IdentityExt-for-ServiceRequest" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for ServiceRequest</h3></section></summary><div class="impl-items"><section id="method.get_identity-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#18-20">source</a><a href="#method.get_identity-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.62/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-GuardContext%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#23-27">source</a><a href="#impl-IdentityExt-for-GuardContext%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for GuardContext<'a></h3></section></summary><div class="impl-items"><section id="method.get_identity-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/actix_identity/identity_ext.rs.html#24-26">source</a><a href="#method.get_identity-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fnname">get_identity</a>(&self) -> <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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.62/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script src="../implementors/actix_identity/identity_ext/trait.IdentityExt.js" data-ignore-extern-crates="actix_web" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (eaadb8947 2022-08-27)" ></div></body></html> |