1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-12-01 02:44:37 +01:00
actix-extras/actix_web_httpauth/headers/authorization/trait.Scheme.html

10 lines
9.4 KiB
HTML
Raw Normal View History

<!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="Authentication scheme for `Authorization` header."><meta name="keywords" content="rust, rustlang, rust-lang, Scheme"><title>actix_web_httpauth::headers::authorization::Scheme - Rust</title><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="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><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">&#9776;</div><a href='../../../actix_web_httpauth/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Trait Scheme</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.parse">parse</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../../index.html">actix_web_httpauth</a>::<wbr><a href="../index.html">headers</a>::<wbr><a href="index.html">authorization</a></p><div id="sidebar-vars" data-name="Scheme" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">actix_web_httpauth</a>::<wbr><a href="../index.html">headers</a>::<wbr><a href="index.html">authorization</a>::<wbr><a class="trait" href="">Scheme</a></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">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/actix_web_httpauth/headers/authorization/scheme/mod.rs.html#12-15" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Scheme: IntoHeaderValue + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
fn <a href="#tymethod.parse" class="fnname">parse</a>(header: &amp;<a class="struct" href="https://docs.rs/http/0.2.3/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="../../../actix_web_httpauth/headers/authorization/enum.ParseError.html" title="enum actix_web_httpauth::headers::authorization::ParseError">ParseError</a>&gt;;
}</pre></div><div class="docblock"><p>Authentication scheme for <a href="./struct.Authorization.html"><code>Authorization</code></a>
header.</p>
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.parse" class="method"><code>fn <a href="#tymethod.parse" class="fnname">parse</a>(header: &amp;<a class="struct" href="https://docs.rs/http/0.2.3/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="../../../actix_web_httpauth/headers/authorization/enum.ParseError.html" title="enum actix_web_httpauth::headers::authorization::ParseError">ParseError</a>&gt;</code><a class="srclink" href="../../../src/actix_web_httpauth/headers/authorization/scheme/mod.rs.html#14" title="goto source code">[src]</a></h3><div class="docblock"><p>Try to parse the authentication scheme from the <code>Authorization</code> header.</p>
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-Scheme" class="impl"><code class="in-band">impl <a class="trait" href="../../../actix_web_httpauth/headers/authorization/trait.Scheme.html" title="trait actix_web_httpauth::headers::authorization::Scheme">Scheme</a> for <a class="struct" href="../../../actix_web_httpauth/headers/authorization/struct.Basic.html" title="struct actix_web_httpauth::headers::authorization::Basic">Basic</a></code><a href="#impl-Scheme" class="anchor"></a><a class="srclink" href="../../../src/actix_web_httpauth/headers/authorization/scheme/basic.rs.html#50-83" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.parse" class="method hidden"><code>fn <a href="#method.parse" class="fnname">parse</a>(header: &amp;<a class="struct" href="https://docs.rs/http/0.2.3/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="../../../actix_web_httpauth/headers/authorization/enum.ParseError.html" title="enum actix_web_httpauth::headers::authorization::ParseError">ParseError</a>&gt;</code><a class="srclink" href="../../../src/actix_web_httpauth/headers/authorization/scheme/basic.rs.html#51-82" title="goto source code">[src]</a></h4></div><h3 id="impl-Scheme-1" class="impl"><code class="in-band">impl <a class="trait" href="../../../actix_web_httpauth/headers/authorization/trait.Scheme.html" title="trait actix_web_httpauth::headers::authorization::Scheme">Scheme</a> for <a class="struct" href="../../../actix_web_httpauth/headers/authorization/struct.Bearer.html" title="struct actix_web_httpauth::headers::authorization::Bearer">Bearer</a></code><a href="#impl-Scheme-1" class="anchor"></a><a class="srclink" href="../../../src/actix_web_httpauth/headers/authorization/scheme/bearer.rs.html#43-62" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.parse-1" class="method hidden"><code>fn <a href="#method.parse-1" class="fnname">parse</a>(header: &amp;<a class="struct" href="https://docs.rs/http/0.2.3/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="../../../actix_web_httpauth/headers/authorization/enum.ParseError.html" title="enum actix_web_httpauth::headers::authorization::ParseError">ParseError</a>&gt;</code><a class="srclink" href="../../../src/actix_web_httpauth/headers/authorization/scheme/bearer.rs.html#44-61" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/actix_web_httpauth/headers/authorization/trait.Scheme.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-search-js="../../../search-index.js"></div>
<script src="../../../main.js"></script></body></html>