2024-04-01 18:20:10 +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 = "Helper trait to retrieve an `Identity` instance from various `actix-web`’ > < title > IdentityExt in actix_identity - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . write ( ` <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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"> ` ) < / script > < link rel = "stylesheet" href = "../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../static.files/rustdoc-e935ef01ae1c1829.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.79.0-nightly (805813650 2024-03-31)" data-channel = "nightly" data-search-js = "search-42d8da7a6b9792c2.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../static.files/storage-4c98445ec4002617.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../static.files/main-12cf3b4f4f9dc36d.js" > < / script > < noscript > < link rel = "stylesheet" href = "../static.files/noscript-04d5337699b92874.css" > < / noscript > < link rel = "icon" href = "https://actix.rs/favicon.ico" > < / 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" title = "show sidebar" > < / 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.7.1< / span > < / h2 > < / div > < 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'a%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 > < h3 > < a href = "#implementors" > Implementors< / a > < / h3 > < / section > < h2 > < a href = "index.html" > In crate actix_identity< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
2023-12-18 17:32:00 +01:00
< main > < div class = "width-limiter" > < nav class = "sub" > < form class = "search-form" > < span > < / span > < div id = "sidebar-button" tabindex = "-1" > < a href = "../actix_identity/all.html" title = "show sidebar" > < / a > < / div > < input class = "search-input" name = "search" aria-label = "Run search in the documentation" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < div id = "help-button" tabindex = "-1" > < a href = "../help.html" title = "help" > ?< / 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-7b819b6101059cd0.svg" > < / a > < / div > < / form > < / nav > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Trait < a href = "index.html" > actix_identity< / a > ::< wbr > < a class = "trait" href = "#" > IdentityExt< / a > < button id = "copy-path" 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 = "src" href = "../src/actix_identity/identity_ext.rs.html#6-9" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait IdentityExt {
2023-03-22 21:53:05 +01:00
// Required method
2023-01-07 03:07:51 +01:00
fn < a href = "#tymethod.get_identity" class = "fn" > 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 = "enum" href = "error/enum.GetIdentityError.html" title = "enum actix_identity::error::GetIdentityError" > GetIdentityError< / a > > ;
2023-03-22 21:53:05 +01:00
}< / code > < / pre > < details class = "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 = "struct actix_identity::Identity" > < code > Identity< / code > < / a > instance from various < code > actix-web< / code > ’ < / p >
2023-12-04 17:11:53 +01:00
< / div > < / details > < h2 id = "required-methods" class = "section-header" > Required Methods< a href = "#required-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.get_identity" class = "method" > < a class = "src rightside" href = "../src/actix_identity/identity_ext.rs.html#8" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.get_identity" class = "fn" > 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 = "enum" href = "error/enum.GetIdentityError.html" title = "enum actix_identity::error::GetIdentityError" > GetIdentityError< / a > > < / 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 = "section-header" > Implementations on Foreign Types< a href = "#foreign-impls" class = "anchor" > §< / a > < / h2 > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-IdentityExt-for-HttpRequest" class = "impl" > < a class = "src 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" > < a class = "src 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 = "fn" > 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 = "enum" href = "error/enum.GetIdentityError.html" title = "enum actix_identity::error::GetIdentityError" > GetIdentityError< / a > > < / h4 > < / section > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-IdentityExt-for-ServiceRequest" class = "impl" > < a class = "src 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" > < a class = "src 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 = "fn" > 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 = "enum" href = "error/enum.GetIdentityError.html" title = "enum actix_identity::error::GetIdentityError" > GetIdentityError< / a > > < / h4 > < / section > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-IdentityExt-for-GuardContext%3C'a%3E" class = "impl" > < a class = "src rightside" href = "../src/actix_identity/identity_ext.rs.html#23-27" > source< / a > < a href = "#impl-IdentityExt-for-GuardContext%3C'a%3E" class = "anchor" > §< / a > < h3 class = "code-header" > 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" > < a class = "src 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 = "fn" > 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 = "enum" href = "error/enum.GetIdentityError.html" title = "enum actix_identity::error::GetIdentityError" > GetIdentityError< / a > > < / h4 > < / section > < / div > < / details > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < / div > < script src = "../trait.impl/actix_identity/identity_ext/trait.IdentityExt.js" data-ignore-extern-crates = "actix_web" async > < / script > < / section > < / div > < / main > < / body > < / html >
