actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2025-02-23 02:43:16 +01:00
Code Issues Releases Wiki Activity
actix-extras/src/actix_web_httpauth/extractors/errors.rs.html

160 lines
9.0 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ b95ce3a2101f141ee673b6c7ee552d9603310394 🚀
2022-10-30 16:29:12 +00:00
<!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="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" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.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"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../actix_web_httpauth/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
Deploying to gh-pages from @ 2d6397365414c8e0192966171813e0a7f1c10754 🚀
2022-03-15 16:29:58 +00:00
<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>
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
<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>
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
</pre><pre class="rust"><code><span class="kw">use </span>std::{error::Error, fmt};
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">use </span>actix_web::{http::StatusCode, HttpResponse, ResponseError};
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">use </span><span class="kw">crate</span>::headers::www_authenticate::{Challenge, WwwAuthenticate};
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="doccomment">/// Authentication error returned by authentication extractors.
///
/// Different extractors may extend `AuthenticationError` implementation in order to provide access
/// inner challenge fields.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>AuthenticationError&lt;C: Challenge&gt; {
challenge: C,
status_code: StatusCode,
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">impl</span>&lt;C: Challenge&gt; AuthenticationError&lt;C&gt; {
<span class="doccomment">/// Creates new authentication error from the provided `challenge`.
///
/// By default returned error will resolve into the `HTTP 401` status code.
</span><span class="kw">pub fn </span>new(challenge: C) -&gt; AuthenticationError&lt;C&gt; {
AuthenticationError {
challenge,
status_code: StatusCode::UNAUTHORIZED,
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="doccomment">/// Returns mutable reference to the inner challenge instance.
</span><span class="kw">pub fn </span>challenge_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>C {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.challenge
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="doccomment">/// Returns mutable reference to the inner status code.
///
/// Can be used to override returned status code, but by default this lib tries to stick to the
/// RFC, so it might be unreasonable.
</span><span class="kw">pub fn </span>status_code_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>StatusCode {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.status_code
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">impl</span>&lt;C: Challenge&gt; fmt::Display <span class="kw">for </span>AuthenticationError&lt;C&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
fmt::Display::fmt(<span class="kw-2">&amp;</span><span class="self">self</span>.status_code, f)
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">impl</span>&lt;C: Challenge + <span class="lifetime">&#39;static</span>&gt; Error <span class="kw">for </span>AuthenticationError&lt;C&gt; {}
Deploying to gh-pages from @ ff06958b32203966962f2de28442d45fea5e9fa6 🚀
2022-07-21 01:52:33 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">impl</span>&lt;C: Challenge + <span class="lifetime">&#39;static</span>&gt; ResponseError <span class="kw">for </span>AuthenticationError&lt;C&gt; {
<span class="kw">fn </span>status_code(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; StatusCode {
<span class="self">self</span>.status_code
Deploying to gh-pages from @ ff06958b32203966962f2de28442d45fea5e9fa6 🚀
2022-07-21 01:52:33 +00:00
}
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">fn </span>error_response(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; HttpResponse {
HttpResponse::build(<span class="self">self</span>.status_code())
.insert_header(WwwAuthenticate(<span class="self">self</span>.challenge.clone()))
.finish()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
}
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>actix_web::Error;
Deploying to gh-pages from @ 8fd1772d5e84c3481b004982b8b4e4ad9aec30f2 🚀
2022-03-29 10:59:51 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::headers::www_authenticate::basic::Basic;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_status_code_is_preserved_across_error_conversions() {
<span class="kw">let </span>ae = AuthenticationError::new(Basic::default());
<span class="kw">let </span>expected = ae.status_code;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
<span class="comment">// Converting the AuthenticationError into a ResponseError should preserve the status code.
</span><span class="kw">let </span>err = Error::from(ae);
<span class="kw">let </span>res_err = err.as_response_error();
<span class="macro">assert_eq!</span>(expected, res_err.status_code());
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 11:49:07 +00:00
}
}
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-30 22:13:55 +00:00
</code></pre></div>
Deploying to gh-pages from @ b95ce3a2101f141ee673b6c7ee552d9603310394 🚀
2022-10-30 16:29:12 +00:00
</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.66.0-nightly (5e9772042 2022-10-29)" ></div></body></html>
Reference in New Issue Copy Permalink