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
10 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 20:53:05 +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`."><title>errors.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c4dbdcde0fbd8430.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_web_httpauth" data-themes="" data-resource-suffix="" data-rustdoc-version="1.70.0-nightly (1db9c061d 2023-03-21)" data-search-js="search-a6dd7f063a44c279.js" data-settings-js="settings-f0c5c39777a9a2f6.js" data-settings-css="settings-0bcba95ff279c1db.css" data-theme-light-css="light-db279b6232be9c13.css" data-theme-dark-css="dark-cf923f49f397b216.css" data-theme-ayu-css="ayu-be46fdc453a55015.css" ></div><script src="../../../static.files/storage-9184409068f70b79.js"></script><script defer src="../../../static.files/source-script-1b95b7cca98b26e5.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../static.files/main-f5a2577c5297a973.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../../static.files/light-db279b6232be9c13.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../../static.files/dark-cf923f49f397b216.css"><link rel="stylesheet" href="../../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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><nav class="sub"><a class="sub-logo-container" href="../../../actix_web_httpauth/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" 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="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><a href="#1" id="1">1</a>
Deploying to gh-pages from @ 1774b8a36ef145bb85e2c0db50c9ff78f844804e 🚀
2022-12-01 10:49:14 +00:00
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
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.
Deploying to gh-pages from @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 09:33:31 +00:00
</span><span class="attr">#[derive(Debug)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
</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 @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 09:33:31 +00:00
<span class="attr">#[cfg(test)]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
</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 @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀
2022-11-08 09:33:31 +00:00
<span class="attr">#[test]
Deploying to gh-pages from @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀
2022-08-24 17:10:06 +00:00
</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 @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀
2023-03-22 20:53:05 +00:00
</section></main></body></html>
Reference in New Issue Copy Permalink