blob: 11baeb485ed94d9075fee69e6dd847d1590545c5 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/http-0.2.9/src/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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"><a class="sidebar-logo" href="../../http/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../http/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><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></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::error;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::result;
<span class="kw">use </span><span class="kw">crate</span>::header;
<span class="kw">use </span><span class="kw">crate</span>::method;
<span class="kw">use </span><span class="kw">crate</span>::status;
<span class="kw">use </span><span class="kw">crate</span>::uri;
<span class="doccomment">/// A generic &quot;error&quot; for HTTP connections
///
/// This error type is less specific than the error returned from other
/// functions in this crate, but all other errors can be converted to this
/// error. Consumers of this crate can typically consume and work with this form
/// of error for conversions with the `?` operator.
</span><span class="kw">pub struct </span>Error {
inner: ErrorKind,
}
<span class="doccomment">/// A `Result` typedef to use with the `http::Error` type
</span><span class="kw">pub type </span><span class="prelude-ty">Result</span>&lt;T&gt; = result::Result&lt;T, Error&gt;;
<span class="kw">enum </span>ErrorKind {
StatusCode(status::InvalidStatusCode),
Method(method::InvalidMethod),
Uri(uri::InvalidUri),
UriParts(uri::InvalidUriParts),
HeaderName(header::InvalidHeaderName),
HeaderValue(header::InvalidHeaderValue),
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Error {
<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) -&gt; fmt::Result {
f.debug_tuple(<span class="string">&quot;http::Error&quot;</span>)
<span class="comment">// Skip the noise of the ErrorKind enum
</span>.field(<span class="kw-2">&amp;</span><span class="self">self</span>.get_ref())
.finish()
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Error {
<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="self">self</span>.get_ref(), f)
}
}
<span class="kw">impl </span>Error {
<span class="doccomment">/// Return true if the underlying error has the same type as T.
</span><span class="kw">pub fn </span>is&lt;T: error::Error + <span class="lifetime">&#39;static</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.get_ref().is::&lt;T&gt;()
}
<span class="doccomment">/// Return a reference to the lower level, inner error.
</span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>) {
<span class="kw">use </span><span class="self">self</span>::ErrorKind::<span class="kw-2">*</span>;
<span class="kw">match </span><span class="self">self</span>.inner {
StatusCode(<span class="kw-2">ref </span>e) =&gt; e,
Method(<span class="kw-2">ref </span>e) =&gt; e,
Uri(<span class="kw-2">ref </span>e) =&gt; e,
UriParts(<span class="kw-2">ref </span>e) =&gt; e,
HeaderName(<span class="kw-2">ref </span>e) =&gt; e,
HeaderValue(<span class="kw-2">ref </span>e) =&gt; e,
}
}
}
<span class="kw">impl </span>error::Error <span class="kw">for </span>Error {
<span class="comment">// Return any available cause from the inner error. Note the inner error is
// not itself the cause.
</span><span class="kw">fn </span>source(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>)&gt; {
<span class="self">self</span>.get_ref().source()
}
}
<span class="kw">impl </span>From&lt;status::InvalidStatusCode&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: status::InvalidStatusCode) -&gt; Error {
Error {
inner: ErrorKind::StatusCode(err),
}
}
}
<span class="kw">impl </span>From&lt;method::InvalidMethod&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: method::InvalidMethod) -&gt; Error {
Error {
inner: ErrorKind::Method(err),
}
}
}
<span class="kw">impl </span>From&lt;uri::InvalidUri&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: uri::InvalidUri) -&gt; Error {
Error {
inner: ErrorKind::Uri(err),
}
}
}
<span class="kw">impl </span>From&lt;uri::InvalidUriParts&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: uri::InvalidUriParts) -&gt; Error {
Error {
inner: ErrorKind::UriParts(err),
}
}
}
<span class="kw">impl </span>From&lt;header::InvalidHeaderName&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: header::InvalidHeaderName) -&gt; Error {
Error {
inner: ErrorKind::HeaderName(err),
}
}
}
<span class="kw">impl </span>From&lt;header::InvalidHeaderValue&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: header::InvalidHeaderValue) -&gt; Error {
Error {
inner: ErrorKind::HeaderValue(err),
}
}
}
<span class="kw">impl </span>From&lt;std::convert::Infallible&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: std::convert::Infallible) -&gt; Error {
<span class="kw">match </span>err {}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>inner_error_is_invalid_status_code() {
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = status::StatusCode::from_u16(<span class="number">6666</span>) {
<span class="kw">let </span>err: Error = e.into();
<span class="kw">let </span>ie = err.get_ref();
<span class="macro">assert!</span>(!ie.is::&lt;header::InvalidHeaderValue&gt;());
<span class="macro">assert!</span>(ie.is::&lt;status::InvalidStatusCode&gt;());
ie.downcast_ref::&lt;status::InvalidStatusCode&gt;().unwrap();
<span class="macro">assert!</span>(!err.is::&lt;header::InvalidHeaderValue&gt;());
<span class="macro">assert!</span>(err.is::&lt;status::InvalidStatusCode&gt;());
} <span class="kw">else </span>{
<span class="macro">panic!</span>(<span class="string">&quot;Bad status allowed!&quot;</span>);
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>