mirror of
https://github.com/actix/actix-extras.git
synced 2025-08-30 11:08:08 +02:00
Deploying to gh-pages from @ e10937103e 🚀
This commit is contained in:
robjtede
@@ -24,16 +24,16 @@ response header.</p>
|
||||
}</code></pre></div>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#94-104" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.user_id" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#96-98" title="goto source code">[src]</a></div><a href="#method.user_id" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.user_id" class="fnname">user_id</a>(&self) -> &<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></h4></div></summary><div class="docblock"><p>Returns client’s user-ID.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.password" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#101-103" title="goto source code">[src]</a></div><a href="#method.password" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.password" class="fnname">password</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></h4></div></summary><div class="docblock"><p>Returns client’s password.</p>
|
||||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-AuthExtractor" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#132-152" 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="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="../trait.AuthExtractor.html#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></summary><div class='docblock'><p>The associated error which can be returned.</p>
|
||||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-AuthExtractor" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#129-149" 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="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="../trait.AuthExtractor.html#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></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="type trait-impl has-srclink"><a href="#associatedtype.Future" class="anchor"></a><h4 class="code-header">type <a href="../trait.AuthExtractor.html#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></summary><div class='docblock'><p>Future that resolves into extracted credentials type.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_service_request" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#136-151" title="goto source code">[src]</a></div><a href="#method.from_service_request" class="anchor"></a><h4 class="code-header">fn <a href="../trait.AuthExtractor.html#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><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_service_request" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#133-148" title="goto source code">[src]</a></div><a href="#method.from_service_request" class="anchor"></a><h4 class="code-header">fn <a href="../trait.AuthExtractor.html#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></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Clone" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#91" title="goto source code">[src]</a></div><a href="#impl-Clone" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#91" title="goto source code">[src]</a></div><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h4></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_from" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130" title="goto source code">[src]</a></div><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></div></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#91" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#91" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-FromRequest" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#106-130" title="goto source code">[src]</a></div><a href="#impl-FromRequest" class="anchor"></a><h3 class="code-header in-band">impl FromRequest for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><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> = 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::Error>></h4></div></summary><div class='docblock'><p>Future that resolves to a Self.</p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-FromRequest" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#106-127" title="goto source code">[src]</a></div><a href="#impl-FromRequest" class="anchor"></a><h3 class="code-header in-band">impl FromRequest for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><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> = 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::Error>></h4></div></summary><div class='docblock'><p>Future that resolves to a Self.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Config" class="type trait-impl has-srclink"><a href="#associatedtype.Config" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Config" class="type">Config</a> = <a class="struct" href="struct.Config.html" title="struct actix_web_httpauth::extractors::basic::Config">Config</a></h4></div></summary><div class='docblock'><p>Configuration for this extractor.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><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> = <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></summary><div class='docblock'><p>The associated error which can be returned.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_request" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#111-129" title="goto source code">[src]</a></div><a href="#method.from_request" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_request</a>(<br> req: &HttpRequest, <br> _: &mut Payload<br>) -> <Self as FromRequest>::Future</h4></div></summary><div class='docblock'><p>Create a Self from request parts asynchronously.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_request" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/actix_web_httpauth/extractors/basic.rs.html#111-126" title="goto source code">[src]</a></div><a href="#method.from_request" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_request</a>(<br> req: &HttpRequest, <br> _: &mut Payload<br>) -> <Self as FromRequest>::Future</h4></div></summary><div class='docblock'><p>Create a Self from request parts asynchronously.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.extract" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.extract" class="anchor"></a><h4 class="code-header">fn <a href="#method.extract" class="fnname">extract</a>(req: &HttpRequest) -> Self::Future</h4></div></summary><div class='docblock'><p>Create a Self from request head asynchronously. <a href="#method.extract">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.configure" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.configure" class="anchor"></a><h4 class="code-header">fn <a href="#method.configure" class="fnname">configure</a><F>(f: F) -> Self::Config <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::Config) -> Self::Config, </span></h4></div></summary><div class='docblock'><p>Create and configure config instance.</p>
|
||||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="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 <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.BasicAuth.html" title="struct actix_web_httpauth::extractors::basic::BasicAuth">BasicAuth</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
|
||||
Reference in New Issue
Block a user