mirror of
https://github.com/actix/actix-extras.git
synced 2025-02-19 01:05:17 +01:00
211 lines
17 KiB
HTML
211 lines
17 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="Source of the Rust file `actix-web-httpauth/src/extractors/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</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><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.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 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 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></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"><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>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10"> 10</span>
|
||
<span id="11"> 11</span>
|
||
<span id="12"> 12</span>
|
||
<span id="13"> 13</span>
|
||
<span id="14"> 14</span>
|
||
<span id="15"> 15</span>
|
||
<span id="16"> 16</span>
|
||
<span id="17"> 17</span>
|
||
<span id="18"> 18</span>
|
||
<span id="19"> 19</span>
|
||
<span id="20"> 20</span>
|
||
<span id="21"> 21</span>
|
||
<span id="22"> 22</span>
|
||
<span id="23"> 23</span>
|
||
<span id="24"> 24</span>
|
||
<span id="25"> 25</span>
|
||
<span id="26"> 26</span>
|
||
<span id="27"> 27</span>
|
||
<span id="28"> 28</span>
|
||
<span id="29"> 29</span>
|
||
<span id="30"> 30</span>
|
||
<span id="31"> 31</span>
|
||
<span id="32"> 32</span>
|
||
<span id="33"> 33</span>
|
||
<span id="34"> 34</span>
|
||
<span id="35"> 35</span>
|
||
<span id="36"> 36</span>
|
||
<span id="37"> 37</span>
|
||
<span id="38"> 38</span>
|
||
<span id="39"> 39</span>
|
||
<span id="40"> 40</span>
|
||
<span id="41"> 41</span>
|
||
<span id="42"> 42</span>
|
||
<span id="43"> 43</span>
|
||
<span id="44"> 44</span>
|
||
<span id="45"> 45</span>
|
||
<span id="46"> 46</span>
|
||
<span id="47"> 47</span>
|
||
<span id="48"> 48</span>
|
||
<span id="49"> 49</span>
|
||
<span id="50"> 50</span>
|
||
<span id="51"> 51</span>
|
||
<span id="52"> 52</span>
|
||
<span id="53"> 53</span>
|
||
<span id="54"> 54</span>
|
||
<span id="55"> 55</span>
|
||
<span id="56"> 56</span>
|
||
<span id="57"> 57</span>
|
||
<span id="58"> 58</span>
|
||
<span id="59"> 59</span>
|
||
<span id="60"> 60</span>
|
||
<span id="61"> 61</span>
|
||
<span id="62"> 62</span>
|
||
<span id="63"> 63</span>
|
||
<span id="64"> 64</span>
|
||
<span id="65"> 65</span>
|
||
<span id="66"> 66</span>
|
||
<span id="67"> 67</span>
|
||
<span id="68"> 68</span>
|
||
<span id="69"> 69</span>
|
||
<span id="70"> 70</span>
|
||
<span id="71"> 71</span>
|
||
<span id="72"> 72</span>
|
||
<span id="73"> 73</span>
|
||
<span id="74"> 74</span>
|
||
<span id="75"> 75</span>
|
||
<span id="76"> 76</span>
|
||
<span id="77"> 77</span>
|
||
<span id="78"> 78</span>
|
||
<span id="79"> 79</span>
|
||
<span id="80"> 80</span>
|
||
<span id="81"> 81</span>
|
||
<span id="82"> 82</span>
|
||
<span id="83"> 83</span>
|
||
<span id="84"> 84</span>
|
||
<span id="85"> 85</span>
|
||
<span id="86"> 86</span>
|
||
<span id="87"> 87</span>
|
||
<span id="88"> 88</span>
|
||
<span id="89"> 89</span>
|
||
<span id="90"> 90</span>
|
||
<span id="91"> 91</span>
|
||
<span id="92"> 92</span>
|
||
<span id="93"> 93</span>
|
||
<span id="94"> 94</span>
|
||
<span id="95"> 95</span>
|
||
<span id="96"> 96</span>
|
||
<span id="97"> 97</span>
|
||
<span id="98"> 98</span>
|
||
<span id="99"> 99</span>
|
||
<span id="100">100</span>
|
||
<span id="101">101</span>
|
||
<span id="102">102</span>
|
||
<span id="103">103</span>
|
||
</pre><pre class="rust"><code><span class="doccomment">//! Type-safe authentication information extractors</span>
|
||
|
||
<span class="kw">use</span> <span class="ident">std</span>::{
|
||
<span class="ident">future::Future</span>,
|
||
<span class="ident">pin::Pin</span>,
|
||
<span class="ident">task</span>::{<span class="ident">Context</span>, <span class="ident">Poll</span>},
|
||
};
|
||
|
||
<span class="kw">use</span> <span class="ident">actix_web::dev::ServiceRequest</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web::Error</span>;
|
||
<span class="kw">use</span> <span class="ident">futures_core::ready</span>;
|
||
<span class="kw">use</span> <span class="ident">pin_project_lite::pin_project</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">basic</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">bearer</span>;
|
||
<span class="kw">mod</span> <span class="ident">config</span>;
|
||
<span class="kw">mod</span> <span class="ident">errors</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::config::AuthExtractorConfig</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::errors::AuthenticationError</span>;
|
||
|
||
<span class="doccomment">/// Trait implemented by types that can extract</span>
|
||
<span class="doccomment">/// HTTP authentication scheme credentials from the request.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// It is very similar to actix' `FromRequest` trait,</span>
|
||
<span class="doccomment">/// except it operates with a `ServiceRequest` struct instead,</span>
|
||
<span class="doccomment">/// therefore it can be used in the middlewares.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// You will not need it unless you want to implement your own</span>
|
||
<span class="doccomment">/// authentication scheme.</span>
|
||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">AuthExtractor</span>: <span class="ident">Sized</span> {
|
||
<span class="doccomment">/// The associated error which can be returned.</span>
|
||
<span class="kw">type</span> <span class="ident">Error</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span>;
|
||
|
||
<span class="doccomment">/// Future that resolves into extracted credentials type.</span>
|
||
<span class="kw">type</span> <span class="ident">Future</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</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="doccomment">/// Parse the authentication credentials from the actix' `ServiceRequest`.</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="ident"><span class="self">Self</span>::Future</span>;
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">AuthExtractor</span><span class="op">></span> <span class="ident">AuthExtractor</span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">T::Error</span>;
|
||
|
||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">AuthExtractorOptFut</span><span class="op"><</span><span class="ident">T::Future</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="ident"><span class="self">Self</span>::Future</span> {
|
||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">T::from_service_request</span>(<span class="ident">req</span>);
|
||
<span class="ident">AuthExtractorOptFut</span> { <span class="ident">fut</span> }
|
||
}
|
||
}
|
||
|
||
<span class="macro">pin_project!</span> {
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AuthExtractorOptFut</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
|
||
<span class="attribute">#[<span class="ident">pin</span>]</span>
|
||
<span class="ident">fut</span>: <span class="ident">F</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">AuthExtractorOptFut</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">F</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span><span class="op">></span>,
|
||
{
|
||
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>, <span class="ident">E</span><span class="op">></span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>, <span class="ident">cx</span>: <span class="kw-2">&mut</span> <span class="ident">Context</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">Poll</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Output</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="macro">ready!</span>(<span class="self">self</span>.<span class="ident">project</span>().<span class="ident">fut</span>.<span class="ident">poll</span>(<span class="ident">cx</span>));
|
||
<span class="ident">Poll::Ready</span>(<span class="prelude-val">Ok</span>(<span class="ident">res</span>.<span class="ident">ok</span>()))
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">AuthExtractor</span><span class="op">></span> <span class="ident">AuthExtractor</span> <span class="kw">for</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">T::Error</span><span class="op">></span> {
|
||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">T::Error</span>;
|
||
|
||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">AuthExtractorResFut</span><span class="op"><</span><span class="ident">T::Future</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="ident"><span class="self">Self</span>::Future</span> {
|
||
<span class="ident">AuthExtractorResFut</span> {
|
||
<span class="ident">fut</span>: <span class="ident">T::from_service_request</span>(<span class="ident">req</span>),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="macro">pin_project!</span> {
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AuthExtractorResFut</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
|
||
<span class="attribute">#[<span class="ident">pin</span>]</span>
|
||
<span class="ident">fut</span>: <span class="ident">F</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">AuthExtractorResFut</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">F</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span><span class="op">></span>,
|
||
{
|
||
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">F::Output</span>, <span class="ident">E</span><span class="op">></span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>, <span class="ident">cx</span>: <span class="kw-2">&mut</span> <span class="ident">Context</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">Poll</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Output</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="macro">ready!</span>(<span class="self">self</span>.<span class="ident">project</span>().<span class="ident">fut</span>.<span class="ident">poll</span>(<span class="ident">cx</span>));
|
||
<span class="ident">Poll::Ready</span>(<span class="prelude-val">Ok</span>(<span class="ident">res</span>))
|
||
}
|
||
}
|
||
</code></pre></div>
|
||
</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> |