mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-25 08:22:43 +01:00
7 lines
8.5 KiB
HTML
7 lines
8.5 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="Authentication scheme for `Authorization` header."><title>Scheme in actix_web_httpauth::headers::authorization - 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-9e1300b5663a8a03.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_web_httpauth" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0-nightly (ab5bda1aa 2024-04-08)" data-channel="nightly" data-search-js="search-ffac13a0df2b1870.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-c97aec732c613ca4.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-09095024cf37855e.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_web_httpauth/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_web_httpauth/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../../actix_web_httpauth/index.html">actix_web_httpauth</a><span class="version">0.8.1</span></h2></div><h2 class="location"><a href="#">Scheme</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.parse">parse</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In actix_web_httpauth::headers::authorization</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../actix_web_httpauth/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 ‘S’ to search, ‘?’ for more options…" 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_web_httpauth</a>::<wbr><a href="../index.html">headers</a>::<wbr><a href="index.html">authorization</a>::<wbr><a class="trait" href="#">Scheme</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_web_httpauth/headers/authorization/scheme/mod.rs.html#11-14">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Scheme: TryIntoHeaderValue + <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> {
|
||
// Required method
|
||
fn <a href="#tymethod.parse" class="fn">parse</a>(header: &<a class="struct" href="https://docs.rs/http/0.2.11/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="enum" href="enum.ParseError.html" title="enum actix_web_httpauth::headers::authorization::ParseError">ParseError</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Authentication scheme for <a href="struct.Authorization.html" title="struct actix_web_httpauth::headers::authorization::Authorization"><code>Authorization</code></a> header.</p>
|
||
</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.parse" class="method"><a class="src rightside" href="../../../src/actix_web_httpauth/headers/authorization/scheme/mod.rs.html#13">source</a><h4 class="code-header">fn <a href="#tymethod.parse" class="fn">parse</a>(header: &<a class="struct" href="https://docs.rs/http/0.2.11/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="enum" href="enum.ParseError.html" title="enum actix_web_httpauth::headers::authorization::ParseError">ParseError</a>></h4></section></summary><div class="docblock"><p>Try to parse an authentication scheme from the <code>Authorization</code> header.</p>
|
||
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Scheme-for-Basic" class="impl"><a class="src rightside" href="../../../src/actix_web_httpauth/headers/authorization/scheme/basic.rs.html#49-83">source</a><a href="#impl-Scheme-for-Basic" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Scheme.html" title="trait actix_web_httpauth::headers::authorization::Scheme">Scheme</a> for <a class="struct" href="struct.Basic.html" title="struct actix_web_httpauth::headers::authorization::Basic">Basic</a></h3></section><section id="impl-Scheme-for-Bearer" class="impl"><a class="src rightside" href="../../../src/actix_web_httpauth/headers/authorization/scheme/bearer.rs.html#44-64">source</a><a href="#impl-Scheme-for-Bearer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Scheme.html" title="trait actix_web_httpauth::headers::authorization::Scheme">Scheme</a> for <a class="struct" href="struct.Bearer.html" title="struct actix_web_httpauth::headers::authorization::Bearer">Bearer</a></h3></section></div><script src="../../../trait.impl/actix_web_httpauth/headers/authorization/scheme/trait.Scheme.js" async></script></section></div></main></body></html> |