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
d8a3c8a7ac
actix-extras/actix_identity/trait.IdentityExt.html
robjtede d8a3c8a7ac Deploying to gh-pages from @ 8e76c6c628 🚀
2022-11-12 13:34:14 +00:00

5 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-eabf764633b9d7be.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-777f3e9583f8c92d.css"><link rel="stylesheet" disabled href="../static.files/dark-e2f4109f2e82e3af.css"><link rel="stylesheet" disabled href="../static.files/ayu-c360e709a65bed99.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c2d2a5dbaed13e6b.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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">&#9776;</button><a class="sidebar-logo" href="../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">IdentityExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_identity">get_identity</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IdentityExt-for-GuardContext%3C%27a%3E">GuardContext&lt;&#39;a&gt;</a></li><li><a href="#impl-IdentityExt-for-HttpRequest">HttpRequest</a></li><li><a href="#impl-IdentityExt-for-ServiceRequest">ServiceRequest</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In actix_identity</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><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"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">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="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/actix_identity/identity_ext.rs.html#6-9">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait IdentityExt {
fn <a href="#tymethod.get_identity" class="fnname">get_identity</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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;;
}</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 method-toggle" open><summary><section 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>(&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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;</h4></section></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">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>(&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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;</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">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>(&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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;</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">impl&lt;'a&gt; <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for GuardContext&lt;'a&gt;</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>(&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="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.66/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>&gt;</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div 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-static-root-path="../static.files/" data-current-crate="actix_identity" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0-nightly (42325c525 2022-11-11)" data-search-js="search-39ee4160c7dc16c9.js" data-settings-js="settings-3a0b9947ba1bd99a.js" data-settings-css="settings-a66f7524084a489a.css" ></div></body></html>
Reference in New Issue View Git Blame Copy Permalink