mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-24 07:53:00 +01:00
18 lines
18 KiB
HTML
18 lines
18 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="Trait implemented by types that can extract HTTP authentication scheme credentials from the request."><meta name="keywords" content="rust, rustlang, rust-lang, AuthExtractor"><title>AuthExtractor in actix_web_httpauth::extractors - 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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../actix_web_httpauth/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait AuthExtractor</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.Error">Error</a><a href="#associatedtype.Future">Future</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.from_service_request">from_service_request</a></div><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><div class="sidebar-links"><a href="#impl-AuthExtractor-for-Option%3CT%3E">Option<T></a><a href="#impl-AuthExtractor-for-Result%3CT%2C%20T%3A%3AError%3E">Result<T, T::Error></a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../index.html">actix_web_httpauth</a>::<wbr><a href="index.html">extractors</a></h2><div id="sidebar-vars" data-name="AuthExtractor" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_web_httpauth/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">actix_web_httpauth</a>::<wbr><a href="index.html">extractors</a>::<wbr><a class="trait" href="#">AuthExtractor</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><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#31-40" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait AuthExtractor: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
type <a href="#associatedtype.Error" class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Error>;
|
||
type <a href="#associatedtype.Future" class="type">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a>>>;
|
||
fn <a href="#tymethod.from_service_request" class="fnname">from_service_request</a>(req: &ServiceRequest) -> Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Future" title="type actix_web_httpauth::extractors::AuthExtractor::Future">Future</a>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait implemented by types that can extract
|
||
HTTP authentication scheme credentials from the request.</p>
|
||
<p>It is very similar to actix’ <code>FromRequest</code> trait,
|
||
except it operates with a <code>ServiceRequest</code> struct instead,
|
||
therefore it can be used in the middlewares.</p>
|
||
<p>You will not need it unless you want to implement your own
|
||
authentication scheme.</p>
|
||
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#33" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Error></h4></div></summary><div class="docblock"><p>The associated error which can be returned.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Future" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#36" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.Future" class="type">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a>>></h4></div></summary><div class="docblock"><p>Future that resolves into extracted credentials type.</p>
|
||
</div></details></div><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.from_service_request" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#39" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.from_service_request" class="fnname">from_service_request</a>(req: &ServiceRequest) -> Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Future" title="type actix_web_httpauth::extractors::AuthExtractor::Future">Future</a></h4></div></summary><div class="docblock"><p>Parse the authentication credentials from the actix’ <code>ServiceRequest</code>.</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><div id="impl-AuthExtractor-for-Option%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#42-51" title="goto source code">[src]</a></div><a href="#impl-AuthExtractor-for-Option%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="trait.AuthExtractor.html" title="trait actix_web_httpauth::extractors::AuthExtractor">AuthExtractor</a>> <a class="trait" href="trait.AuthExtractor.html" title="trait actix_web_httpauth::extractors::AuthExtractor">AuthExtractor</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h3></div></summary><div class="impl-items"><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = T::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a></h4></div><div id="associatedtype.Future-1" class="type trait-impl has-srclink"><a href="#associatedtype.Future-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Future" class="type">Future</a> = AuthExtractorOptFut<T::<a class="type" href="trait.AuthExtractor.html#associatedtype.Future" title="type actix_web_httpauth::extractors::AuthExtractor::Future">Future</a>></h4></div><div id="method.from_service_request" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#47-50" title="goto source code">[src]</a></div><a href="#method.from_service_request" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_service_request" class="fnname">from_service_request</a>(req: &ServiceRequest) -> Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Future" title="type actix_web_httpauth::extractors::AuthExtractor::Future">Future</a></h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-AuthExtractor-for-Result%3CT%2C%20T%3A%3AError%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#73-83" title="goto source code">[src]</a></div><a href="#impl-AuthExtractor-for-Result%3CT%2C%20T%3A%3AError%3E" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="trait.AuthExtractor.html" title="trait actix_web_httpauth::extractors::AuthExtractor">AuthExtractor</a>> <a class="trait" href="trait.AuthExtractor.html" title="trait actix_web_httpauth::extractors::AuthExtractor">AuthExtractor</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, T::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a>></h3></div></summary><div class="impl-items"><div id="associatedtype.Error-2" class="type trait-impl has-srclink"><a href="#associatedtype.Error-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = T::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a></h4></div><div id="associatedtype.Future-2" class="type trait-impl has-srclink"><a href="#associatedtype.Future-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Future" class="type">Future</a> = AuthExtractorResFut<T::<a class="type" href="trait.AuthExtractor.html#associatedtype.Future" title="type actix_web_httpauth::extractors::AuthExtractor::Future">Future</a>></h4></div><div id="method.from_service_request-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/mod.rs.html#78-82" title="goto source code">[src]</a></div><a href="#method.from_service_request-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_service_request" class="fnname">from_service_request</a>(req: &ServiceRequest) -> Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Future" title="type actix_web_httpauth::extractors::AuthExtractor::Future">Future</a></h4></div></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-AuthExtractor" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/basic.rs.html#128-148" title="goto source code">[src]</a></div><a href="#impl-AuthExtractor" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AuthExtractor.html" title="trait actix_web_httpauth::extractors::AuthExtractor">AuthExtractor</a> for <a class="struct" href="basic/struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><div id="associatedtype.Error-3" class="type trait-impl has-srclink"><a href="#associatedtype.Error-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = <a class="struct" href="struct.AuthenticationError.html" title="struct actix_web_httpauth::extractors::AuthenticationError">AuthenticationError</a><<a class="struct" href="../headers/www_authenticate/basic/struct.Basic.html" title="struct actix_web_httpauth::headers::www_authenticate::basic::Basic">Challenge</a>></h4></div><div id="associatedtype.Future-3" class="type trait-impl has-srclink"><a href="#associatedtype.Future-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Future" class="type">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a>>></h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-AuthExtractor-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/actix_web_httpauth/extractors/bearer.rs.html#123-141" title="goto source code">[src]</a></div><a href="#impl-AuthExtractor-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AuthExtractor.html" title="trait actix_web_httpauth::extractors::AuthExtractor">AuthExtractor</a> for <a class="struct" href="bearer/struct.BearerAuth.html" title="struct actix_web_httpauth::extractors::bearer::BearerAuth">BearerAuth</a></h3></div></summary><div class="impl-items"><div id="associatedtype.Future-4" class="type trait-impl has-srclink"><a href="#associatedtype.Future-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Future" class="type">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="trait.AuthExtractor.html#associatedtype.Error" title="type actix_web_httpauth::extractors::AuthExtractor::Error">Error</a>>></h4></div><div id="associatedtype.Error-4" class="type trait-impl has-srclink"><a href="#associatedtype.Error-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = <a class="struct" href="struct.AuthenticationError.html" title="struct actix_web_httpauth::extractors::AuthenticationError">AuthenticationError</a><<a class="struct" href="../headers/www_authenticate/bearer/struct.Bearer.html" title="struct actix_web_httpauth::headers::www_authenticate::bearer::Bearer">Bearer</a>></h4></div></div></details></div><script type="text/javascript" src="../../implementors/actix_web_httpauth/extractors/trait.AuthExtractor.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0-nightly (83b15bfe1 2021-12-28)" ></div>
|
||
</body></html> |