mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-01 20:47:22 +02:00
Deploying to gh-pages from @ c6f579790f 🚀
This commit is contained in:
robjtede
@@ -1,4 +1,4 @@
|
||||
<!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="Source of the Rust file `actix-web-httpauth/src/extractors/basic.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>basic.rs - source</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 source"><!--[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 href='../../../actix_web_httpauth/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a></nav><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><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" 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><section id="main" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
|
||||
<!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="Source of the Rust file `actix-web-httpauth/src/extractors/basic.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>basic.rs - source</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="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"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[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 href='../../../actix_web_httpauth/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a></nav><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><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" 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><section id="main" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
|
||||
<span id="2"> 2</span>
|
||||
<span id="3"> 3</span>
|
||||
<span id="4"> 4</span>
|
||||
@@ -150,8 +150,7 @@
|
||||
<span id="150">150</span>
|
||||
<span id="151">151</span>
|
||||
<span id="152">152</span>
|
||||
</pre><pre class="rust">
|
||||
<span class="doccomment">//! Extractor for the "Basic" HTTP Authentication Scheme</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Extractor for the "Basic" HTTP Authentication Scheme</span>
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::borrow::Cow</span>;
|
||||
|
||||
@@ -160,11 +159,11 @@
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">FromRequest</span>, <span class="ident">HttpRequest</span>};
|
||||
<span class="kw">use</span> <span class="ident">futures_util::future</span>::{<span class="ident">ready</span>, <span class="ident">Ready</span>};
|
||||
|
||||
<span class="kw">use</span> <span class="kw">super</span><span class="ident">::config::AuthExtractorConfig</span>;
|
||||
<span class="kw">use</span> <span class="kw">super</span><span class="ident">::errors::AuthenticationError</span>;
|
||||
<span class="kw">use</span> <span class="kw">super</span><span class="ident">::AuthExtractor</span>;
|
||||
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::headers::authorization</span>::{<span class="ident">Authorization</span>, <span class="ident">Basic</span>};
|
||||
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::headers::www_authenticate::basic::Basic</span> <span class="kw">as</span> <span class="ident">Challenge</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::config::AuthExtractorConfig</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::errors::AuthenticationError</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::AuthExtractor</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::authorization</span>::{<span class="ident">Authorization</span>, <span class="ident">Basic</span>};
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::www_authenticate::basic::Basic</span> <span class="kw">as</span> <span class="ident">Challenge</span>;
|
||||
|
||||
<span class="doccomment">/// [`BasicAuth`] extractor configuration,</span>
|
||||
<span class="doccomment">/// used for [`WWW-Authenticate`] header later.</span>
|
||||
@@ -198,7 +197,7 @@
|
||||
<span class="kw">impl</span> <span class="ident">AuthExtractorConfig</span> <span class="kw">for</span> <span class="ident">Config</span> {
|
||||
<span class="kw">type</span> <span class="ident">Inner</span> <span class="op">=</span> <span class="ident">Challenge</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span><span class="ident">::Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident"><span class="self">Self</span>::Inner</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
@@ -247,7 +246,7 @@
|
||||
<span class="kw">impl</span> <span class="ident">BasicAuth</span> {
|
||||
<span class="doccomment">/// Returns client's user-ID.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">user_id</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">user_id</span>()
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">user_id</span>()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns client's password.</span>
|
||||
@@ -257,7 +256,7 @@
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">FromRequest</span> <span class="kw">for</span> <span class="ident">BasicAuth</span> {
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="self">Self</span><span class="ident">::Error</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Config</span> <span class="op">=</span> <span class="ident">Config</span>;
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">Challenge</span><span class="op">></span>;
|
||||
|
||||
@@ -271,7 +270,7 @@
|
||||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
|
||||
<span class="comment">// TODO: debug! the original error</span>
|
||||
<span class="kw">let</span> <span class="ident">challenge</span> <span class="op">=</span> <span class="ident">req</span>
|
||||
.<span class="ident">app_data</span>::<span class="op"><</span><span class="self">Self</span><span class="ident">::Config</span><span class="op">></span>()
|
||||
.<span class="ident">app_data</span>::<span class="op"><</span><span class="ident"><span class="self">Self</span>::Config</span><span class="op">></span>()
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">config</span><span class="op">|</span> <span class="ident">config</span>.<span class="number">0</span>.<span class="ident">clone</span>())
|
||||
<span class="comment">// TODO: Add trace! about `Default::default` call</span>
|
||||
.<span class="ident">unwrap_or_else</span>(<span class="ident">Default::default</span>);
|
||||
@@ -284,9 +283,9 @@
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AuthExtractor</span> <span class="kw">for</span> <span class="ident">BasicAuth</span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">Challenge</span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="self">Self</span><span class="ident">::Error</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">from_service_request</span>(<span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">ServiceRequest</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span><span class="ident">::Future</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from_service_request</span>(<span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">ServiceRequest</span>) <span class="op">-</span><span class="op">></span> <span class="ident"><span class="self">Self</span>::Future</span> {
|
||||
<span class="ident">ready</span>(
|
||||
<span class="ident">Authorization</span>::<span class="op"><</span><span class="ident">Basic</span><span class="op">></span><span class="ident">::parse</span>(<span class="ident">req</span>)
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">auth</span><span class="op">|</span> <span class="ident">BasicAuth</span>(<span class="ident">auth</span>.<span class="ident">into_scheme</span>()))
|
||||
@@ -303,7 +302,7 @@
|
||||
)
|
||||
}
|
||||
}
|
||||
</pre></div>
|
||||
</code></pre></div>
|
||||
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-search-index-js="../../../search-index.js" data-search-js="../../../search.js"></div>
|
||||
<script src="../../../main.js"></script><script src="../../../source-script.js"></script><script src="../../../source-files.js"></script>
|
||||
</body></html>
|
||||
Reference in New Issue
Block a user