| <!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/h2-0.3.19/src/frame/reason.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>reason.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="../../../h2/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="../../../h2/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// HTTP/2 error codes. |
| /// |
| /// Error codes are used in `RST_STREAM` and `GOAWAY` frames to convey the |
| /// reasons for the stream or connection error. For example, |
| /// [`SendStream::send_reset`] takes a `Reason` argument. Also, the `Error` type |
| /// may contain a `Reason`. |
| /// |
| /// Error codes share a common code space. Some error codes apply only to |
| /// streams, others apply only to connections, and others may apply to either. |
| /// See [RFC 7540] for more information. |
| /// |
| /// See [Error Codes in the spec][spec]. |
| /// |
| /// [spec]: http://httpwg.org/specs/rfc7540.html#ErrorCodes |
| /// [`SendStream::send_reset`]: struct.SendStream.html#method.send_reset |
| </span><span class="attribute">#[derive(PartialEq, Eq, Clone, Copy)] |
| </span><span class="kw">pub struct </span>Reason(u32); |
| |
| <span class="kw">impl </span>Reason { |
| <span class="doccomment">/// The associated condition is not a result of an error. |
| /// |
| /// For example, a GOAWAY might include this code to indicate graceful |
| /// shutdown of a connection. |
| </span><span class="kw">pub const </span>NO_ERROR: Reason = Reason(<span class="number">0</span>); |
| <span class="doccomment">/// The endpoint detected an unspecific protocol error. |
| /// |
| /// This error is for use when a more specific error code is not available. |
| </span><span class="kw">pub const </span>PROTOCOL_ERROR: Reason = Reason(<span class="number">1</span>); |
| <span class="doccomment">/// The endpoint encountered an unexpected internal error. |
| </span><span class="kw">pub const </span>INTERNAL_ERROR: Reason = Reason(<span class="number">2</span>); |
| <span class="doccomment">/// The endpoint detected that its peer violated the flow-control protocol. |
| </span><span class="kw">pub const </span>FLOW_CONTROL_ERROR: Reason = Reason(<span class="number">3</span>); |
| <span class="doccomment">/// The endpoint sent a SETTINGS frame but did not receive a response in |
| /// a timely manner. |
| </span><span class="kw">pub const </span>SETTINGS_TIMEOUT: Reason = Reason(<span class="number">4</span>); |
| <span class="doccomment">/// The endpoint received a frame after a stream was half-closed. |
| </span><span class="kw">pub const </span>STREAM_CLOSED: Reason = Reason(<span class="number">5</span>); |
| <span class="doccomment">/// The endpoint received a frame with an invalid size. |
| </span><span class="kw">pub const </span>FRAME_SIZE_ERROR: Reason = Reason(<span class="number">6</span>); |
| <span class="doccomment">/// The endpoint refused the stream prior to performing any application |
| /// processing. |
| </span><span class="kw">pub const </span>REFUSED_STREAM: Reason = Reason(<span class="number">7</span>); |
| <span class="doccomment">/// Used by the endpoint to indicate that the stream is no longer needed. |
| </span><span class="kw">pub const </span>CANCEL: Reason = Reason(<span class="number">8</span>); |
| <span class="doccomment">/// The endpoint is unable to maintain the header compression context for |
| /// the connection. |
| </span><span class="kw">pub const </span>COMPRESSION_ERROR: Reason = Reason(<span class="number">9</span>); |
| <span class="doccomment">/// The connection established in response to a CONNECT request was reset |
| /// or abnormally closed. |
| </span><span class="kw">pub const </span>CONNECT_ERROR: Reason = Reason(<span class="number">10</span>); |
| <span class="doccomment">/// The endpoint detected that its peer is exhibiting a behavior that might |
| /// be generating excessive load. |
| </span><span class="kw">pub const </span>ENHANCE_YOUR_CALM: Reason = Reason(<span class="number">11</span>); |
| <span class="doccomment">/// The underlying transport has properties that do not meet minimum |
| /// security requirements. |
| </span><span class="kw">pub const </span>INADEQUATE_SECURITY: Reason = Reason(<span class="number">12</span>); |
| <span class="doccomment">/// The endpoint requires that HTTP/1.1 be used instead of HTTP/2. |
| </span><span class="kw">pub const </span>HTTP_1_1_REQUIRED: Reason = Reason(<span class="number">13</span>); |
| |
| <span class="doccomment">/// Get a string description of the error code. |
| </span><span class="kw">pub fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="kw">match </span><span class="self">self</span>.<span class="number">0 </span>{ |
| <span class="number">0 </span>=> <span class="string">"not a result of an error"</span>, |
| <span class="number">1 </span>=> <span class="string">"unspecific protocol error detected"</span>, |
| <span class="number">2 </span>=> <span class="string">"unexpected internal error encountered"</span>, |
| <span class="number">3 </span>=> <span class="string">"flow-control protocol violated"</span>, |
| <span class="number">4 </span>=> <span class="string">"settings ACK not received in timely manner"</span>, |
| <span class="number">5 </span>=> <span class="string">"received frame when stream half-closed"</span>, |
| <span class="number">6 </span>=> <span class="string">"frame with invalid size"</span>, |
| <span class="number">7 </span>=> <span class="string">"refused stream before processing any application logic"</span>, |
| <span class="number">8 </span>=> <span class="string">"stream no longer needed"</span>, |
| <span class="number">9 </span>=> <span class="string">"unable to maintain the header compression context"</span>, |
| <span class="number">10 </span>=> { |
| <span class="string">"connection established in response to a CONNECT request was reset or abnormally \ |
| closed" |
| </span>} |
| <span class="number">11 </span>=> <span class="string">"detected excessive load generating behavior"</span>, |
| <span class="number">12 </span>=> <span class="string">"security properties do not meet minimum requirements"</span>, |
| <span class="number">13 </span>=> <span class="string">"endpoint requires HTTP/1.1"</span>, |
| <span class="kw">_ </span>=> <span class="string">"unknown reason"</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<u32> <span class="kw">for </span>Reason { |
| <span class="kw">fn </span>from(src: u32) -> Reason { |
| Reason(src) |
| } |
| } |
| |
| <span class="kw">impl </span>From<Reason> <span class="kw">for </span>u32 { |
| <span class="kw">fn </span>from(src: Reason) -> u32 { |
| src.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Reason { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">let </span>name = <span class="kw">match </span><span class="self">self</span>.<span class="number">0 </span>{ |
| <span class="number">0 </span>=> <span class="string">"NO_ERROR"</span>, |
| <span class="number">1 </span>=> <span class="string">"PROTOCOL_ERROR"</span>, |
| <span class="number">2 </span>=> <span class="string">"INTERNAL_ERROR"</span>, |
| <span class="number">3 </span>=> <span class="string">"FLOW_CONTROL_ERROR"</span>, |
| <span class="number">4 </span>=> <span class="string">"SETTINGS_TIMEOUT"</span>, |
| <span class="number">5 </span>=> <span class="string">"STREAM_CLOSED"</span>, |
| <span class="number">6 </span>=> <span class="string">"FRAME_SIZE_ERROR"</span>, |
| <span class="number">7 </span>=> <span class="string">"REFUSED_STREAM"</span>, |
| <span class="number">8 </span>=> <span class="string">"CANCEL"</span>, |
| <span class="number">9 </span>=> <span class="string">"COMPRESSION_ERROR"</span>, |
| <span class="number">10 </span>=> <span class="string">"CONNECT_ERROR"</span>, |
| <span class="number">11 </span>=> <span class="string">"ENHANCE_YOUR_CALM"</span>, |
| <span class="number">12 </span>=> <span class="string">"INADEQUATE_SECURITY"</span>, |
| <span class="number">13 </span>=> <span class="string">"HTTP_1_1_REQUIRED"</span>, |
| other => <span class="kw">return </span>f.debug_tuple(<span class="string">"Reason"</span>).field(<span class="kw-2">&</span>Hex(other)).finish(), |
| }; |
| f.write_str(name) |
| } |
| } |
| |
| <span class="kw">struct </span>Hex(u32); |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Hex { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| fmt::LowerHex::fmt(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, f) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>Reason { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="macro">write!</span>(fmt, <span class="string">"{}"</span>, <span class="self">self</span>.description()) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="h2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
