mirror of
https://github.com/actix/actix-extras.git
synced 2025-04-28 04:23:23 +02:00
213 lines
16 KiB
HTML
213 lines
16 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/headers/authorization/header.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>header.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 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">☰</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"><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"><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><div class="example-wrap"><pre class="rust ">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">error</span>::<span class="ident">ParseError</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">http</span>::<span class="ident">header</span>::{
|
||
<span class="ident">Header</span>, <span class="ident">HeaderName</span>, <span class="ident">HeaderValue</span>, <span class="ident">IntoHeaderValue</span>, <span class="ident">AUTHORIZATION</span>,
|
||
};
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">HttpMessage</span>;
|
||
|
||
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">headers</span>::<span class="ident">authorization</span>::<span class="ident">scheme</span>::<span class="ident">Scheme</span>;
|
||
|
||
<span class="doccomment">/// `Authorization` header, defined in [RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2)</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// The "Authorization" header field allows a user agent to authenticate</span>
|
||
<span class="doccomment">/// itself with an origin server -- usually, but not necessarily, after</span>
|
||
<span class="doccomment">/// receiving a 401 (Unauthorized) response. Its value consists of</span>
|
||
<span class="doccomment">/// credentials containing the authentication information of the user</span>
|
||
<span class="doccomment">/// agent for the realm of the resource being requested.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// `Authorization` header is generic over [authentication</span>
|
||
<span class="doccomment">/// scheme](./trait.Scheme.html).</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// # Example</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="doccomment">/// # use actix_web::http::header::Header;</span>
|
||
<span class="doccomment">/// # use actix_web::{HttpRequest, Result};</span>
|
||
<span class="doccomment">/// # use actix_web_httpauth::headers::authorization::{Authorization, Basic};</span>
|
||
<span class="doccomment">/// fn handler(req: HttpRequest) -> Result<String> {</span>
|
||
<span class="doccomment">/// let auth = Authorization::<Basic>::parse(&req)?;</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// Ok(format!("Hello, {}!", auth.as_ref().user_id()))</span>
|
||
<span class="doccomment">/// }</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Ord</span>, <span class="ident">PartialOrd</span>, <span class="ident">Hash</span>, <span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span>(<span class="ident">S</span>);
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">S</span>: <span class="ident">Scheme</span>,
|
||
{
|
||
<span class="doccomment">/// Consumes `Authorization` header and returns inner [`Scheme`]</span>
|
||
<span class="doccomment">/// implementation.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// [`Scheme`]: ./trait.Scheme.html</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_scheme</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">S</span> {
|
||
<span class="self">self</span>.<span class="number">0</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">S</span>: <span class="ident">Scheme</span>,
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">scheme</span>: <span class="ident">S</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||
<span class="ident">Authorization</span>(<span class="ident">scheme</span>)
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">S</span>: <span class="ident">Scheme</span>,
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">as_ref</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">S</span> {
|
||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">AsMut</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">S</span>: <span class="ident">Scheme</span>,
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">S</span> {
|
||
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="number">0</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">Header</span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||
<span class="kw">fn</span> <span class="ident">name</span>() <span class="op">-</span><span class="op">></span> <span class="ident">HeaderName</span> {
|
||
<span class="ident">AUTHORIZATION</span>
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">parse</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">HttpMessage</span><span class="op">></span>(<span class="ident">msg</span>: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ParseError</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">header</span> <span class="op">=</span> <span class="ident">msg</span>.<span class="ident">headers</span>().<span class="ident">get</span>(<span class="ident">AUTHORIZATION</span>).<span class="ident">ok_or</span>(<span class="ident">ParseError</span>::<span class="ident">Header</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">S</span>::<span class="ident">parse</span>(<span class="ident">header</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ParseError</span>::<span class="ident">Header</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Authorization</span>(<span class="ident">scheme</span>))
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">IntoHeaderValue</span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="op"><</span><span class="ident">S</span> <span class="kw">as</span> <span class="ident">IntoHeaderValue</span><span class="op">></span>::<span class="ident">Error</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
|
||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">try_into_value</span>()
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
|
||
<span class="ident">fmt</span>::<span class="ident">Display</span>::<span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">f</span>)
|
||
}
|
||
}
|
||
</pre></div>
|
||
</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><script src="../../../../source-script.js"></script><script src="../../../../source-files.js"></script></body></html> |