<!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/errors.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>errors.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><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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<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">http</span>::<span class="ident">StatusCode</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">HttpResponse</span>, <span class="ident">ResponseError</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">headers</span>::<span class="ident">www_authenticate</span>::<span class="ident">Challenge</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">headers</span>::<span class="ident">www_authenticate</span>::<span class="ident">WwwAuthenticate</span>;
<span class="doccomment">/// Authentication error returned by authentication extractors.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Different extractors may extend `AuthenticationError` implementation</span>
<span class="doccomment">/// in order to provide access to inner challenge fields.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> {
<span class="ident">challenge</span>: <span class="ident">C</span>,
<span class="ident">status_code</span>: <span class="ident">StatusCode</span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
<span class="doccomment">/// Creates new authentication error from the provided `challenge`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// By default returned error will resolve into the `HTTP 401` status code.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">challenge</span>: <span class="ident">C</span>) <span class="op">-</span><span class="op">></span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
<span class="ident">AuthenticationError</span> {
<span class="ident">challenge</span>,
<span class="ident">status_code</span>: <span class="ident">StatusCode</span>::<span class="ident">UNAUTHORIZED</span>,
}
}
<span class="doccomment">/// Returns mutable reference to the inner challenge instance.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">challenge_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">C</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">challenge</span>
}
<span class="doccomment">/// Returns mutable reference to the inner status code.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Can be used to override returned status code, but by default</span>
<span class="doccomment">/// this lib tries to stick to the RFC, so it might be unreasonable.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">status_code_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">StatusCode</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">status_code</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</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="ident">status_code</span>, <span class="ident">f</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Challenge</span><span class="op">></span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {}
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Challenge</span><span class="op">></span> <span class="ident">ResponseError</span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">error_response</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">HttpResponse</span> {
<span class="ident">HttpResponse</span>::<span class="ident">build</span>(<span class="self">self</span>.<span class="ident">status_code</span>)
<span class="comment">// TODO: Get rid of the `.clone()`</span>
.<span class="ident">insert_header</span>(<span class="ident">WwwAuthenticate</span>(<span class="self">self</span>.<span class="ident">challenge</span>.<span class="ident">clone</span>()))
.<span class="ident">finish</span>()
}
<span class="kw">fn</span> <span class="ident">status_code</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">StatusCode</span> {
<span class="self">self</span>.<span class="ident">status_code</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">headers</span>::<span class="ident">www_authenticate</span>::<span class="ident">basic</span>::<span class="ident">Basic</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">Error</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_status_code_is_preserved_across_error_conversions</span>() {
<span class="kw">let</span> <span class="ident">ae</span>: <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">Basic</span><span class="op">></span> <span class="op">=</span> <span class="ident">AuthenticationError</span>::<span class="ident">new</span>(<span class="ident">Basic</span>::<span class="ident">default</span>());
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> <span class="ident">ae</span>.<span class="ident">status_code</span>;
<span class="comment">// Converting the AuthenticationError into a ResponseError should preserve the status code.</span>
<span class="kw">let</span> <span class="ident">e</span> <span class="op">=</span> <span class="ident">Error</span>::<span class="ident">from</span>(<span class="ident">ae</span>);
<span class="kw">let</span> <span class="ident">re</span> <span class="op">=</span> <span class="ident">e</span>.<span class="ident">as_response_error</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">expected</span>, <span class="ident">re</span>.<span class="ident">status_code</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>