| <!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/hyper-0.14.26/src/ext/h1_reason_phrase.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>h1_reason_phrase.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="../../../hyper/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="../../../hyper/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> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::convert::TryFrom; |
| |
| <span class="kw">use </span>bytes::Bytes; |
| |
| <span class="doccomment">/// A reason phrase in an HTTP/1 response. |
| /// |
| /// # Clients |
| /// |
| /// For clients, a `ReasonPhrase` will be present in the extensions of the `http::Response` returned |
| /// for a request if the reason phrase is different from the canonical reason phrase for the |
| /// response's status code. For example, if a server returns `HTTP/1.1 200 Awesome`, the |
| /// `ReasonPhrase` will be present and contain `Awesome`, but if a server returns `HTTP/1.1 200 OK`, |
| /// the response will not contain a `ReasonPhrase`. |
| /// |
| /// ```no_run |
| /// # #[cfg(all(feature = "tcp", feature = "client", feature = "http1"))] |
| /// # async fn fake_fetch() -> hyper::Result<()> { |
| /// use hyper::{Client, Uri}; |
| /// use hyper::ext::ReasonPhrase; |
| /// |
| /// let res = Client::new().get(Uri::from_static("http://example.com/non_canonical_reason")).await?; |
| /// |
| /// // Print out the non-canonical reason phrase, if it has one... |
| /// if let Some(reason) = res.extensions().get::<ReasonPhrase>() { |
| /// println!("non-canonical reason: {}", std::str::from_utf8(reason.as_bytes()).unwrap()); |
| /// } |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// # Servers |
| /// |
| /// When a `ReasonPhrase` is present in the extensions of the `http::Response` written by a server, |
| /// its contents will be written in place of the canonical reason phrase when responding via HTTP/1. |
| </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] |
| </span><span class="kw">pub struct </span>ReasonPhrase(Bytes); |
| |
| <span class="kw">impl </span>ReasonPhrase { |
| <span class="doccomment">/// Gets the reason phrase as bytes. |
| </span><span class="kw">pub fn </span>as_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Converts a static byte slice to a reason phrase. |
| </span><span class="kw">pub fn </span>from_static(reason: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8]) -> <span class="self">Self </span>{ |
| <span class="comment">// TODO: this can be made const once MSRV is >= 1.57.0 |
| </span><span class="kw">if </span>find_invalid_byte(reason).is_some() { |
| <span class="macro">panic!</span>(<span class="string">"invalid byte in static reason phrase"</span>); |
| } |
| <span class="self">Self</span>(Bytes::from_static(reason)) |
| } |
| |
| <span class="doccomment">/// Converts a `Bytes` directly into a `ReasonPhrase` without validating. |
| /// |
| /// Use with care; invalid bytes in a reason phrase can cause serious security problems if |
| /// emitted in a response. |
| </span><span class="kw">pub unsafe fn </span>from_bytes_unchecked(reason: Bytes) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>(reason) |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<<span class="kw-2">&</span>[u8]> <span class="kw">for </span>ReasonPhrase { |
| <span class="kw">type </span>Error = InvalidReasonPhrase; |
| |
| <span class="kw">fn </span>try_from(reason: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(bad_byte) = find_invalid_byte(reason) { |
| <span class="prelude-val">Err</span>(InvalidReasonPhrase { bad_byte }) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(<span class="self">Self</span>(Bytes::copy_from_slice(reason))) |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<Vec<u8>> <span class="kw">for </span>ReasonPhrase { |
| <span class="kw">type </span>Error = InvalidReasonPhrase; |
| |
| <span class="kw">fn </span>try_from(reason: Vec<u8>) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(bad_byte) = find_invalid_byte(<span class="kw-2">&</span>reason) { |
| <span class="prelude-val">Err</span>(InvalidReasonPhrase { bad_byte }) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(<span class="self">Self</span>(Bytes::from(reason))) |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<String> <span class="kw">for </span>ReasonPhrase { |
| <span class="kw">type </span>Error = InvalidReasonPhrase; |
| |
| <span class="kw">fn </span>try_from(reason: String) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(bad_byte) = find_invalid_byte(reason.as_bytes()) { |
| <span class="prelude-val">Err</span>(InvalidReasonPhrase { bad_byte }) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(<span class="self">Self</span>(Bytes::from(reason))) |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>TryFrom<Bytes> <span class="kw">for </span>ReasonPhrase { |
| <span class="kw">type </span>Error = InvalidReasonPhrase; |
| |
| <span class="kw">fn </span>try_from(reason: Bytes) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(bad_byte) = find_invalid_byte(<span class="kw-2">&</span>reason) { |
| <span class="prelude-val">Err</span>(InvalidReasonPhrase { bad_byte }) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Ok</span>(<span class="self">Self</span>(reason)) |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Into<Bytes> <span class="kw">for </span>ReasonPhrase { |
| <span class="kw">fn </span>into(<span class="self">self</span>) -> Bytes { |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>AsRef<[u8]> <span class="kw">for </span>ReasonPhrase { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="doccomment">/// Error indicating an invalid byte when constructing a `ReasonPhrase`. |
| /// |
| /// See [the spec][spec] for details on allowed bytes. |
| /// |
| /// [spec]: https://httpwg.org/http-core/draft-ietf-httpbis-messaging-latest.html#rfc.section.4.p.7 |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>InvalidReasonPhrase { |
| bad_byte: u8, |
| } |
| |
| <span class="kw">impl </span>std::fmt::Display <span class="kw">for </span>InvalidReasonPhrase { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"Invalid byte in reason phrase: {}"</span>, <span class="self">self</span>.bad_byte) |
| } |
| } |
| |
| <span class="kw">impl </span>std::error::Error <span class="kw">for </span>InvalidReasonPhrase {} |
| |
| <span class="kw">const fn </span>is_valid_byte(b: u8) -> bool { |
| <span class="comment">// See https://www.rfc-editor.org/rfc/rfc5234.html#appendix-B.1 |
| </span><span class="kw">const fn </span>is_vchar(b: u8) -> bool { |
| <span class="number">0x21 </span><= b && b <= <span class="number">0x7E |
| </span>} |
| |
| <span class="comment">// See https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#fields.values |
| // |
| // The 0xFF comparison is technically redundant, but it matches the text of the spec more |
| // clearly and will be optimized away. |
| </span><span class="attribute">#[allow(unused_comparisons)] |
| </span><span class="kw">const fn </span>is_obs_text(b: u8) -> bool { |
| <span class="number">0x80 </span><= b && b <= <span class="number">0xFF |
| </span>} |
| |
| <span class="comment">// See https://httpwg.org/http-core/draft-ietf-httpbis-messaging-latest.html#rfc.section.4.p.7 |
| </span>b == <span class="string">b'\t' </span>|| b == <span class="string">b' ' </span>|| is_vchar(b) || is_obs_text(b) |
| } |
| |
| <span class="kw">const fn </span>find_invalid_byte(bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><u8> { |
| <span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>; |
| <span class="kw">while </span>i < bytes.len() { |
| <span class="kw">let </span>b = bytes[i]; |
| <span class="kw">if </span>!is_valid_byte(b) { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(b); |
| } |
| i += <span class="number">1</span>; |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <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>basic_valid() { |
| <span class="kw">const </span>PHRASE: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8] = <span class="string">b"OK"</span>; |
| <span class="macro">assert_eq!</span>(ReasonPhrase::from_static(PHRASE).as_bytes(), PHRASE); |
| <span class="macro">assert_eq!</span>(ReasonPhrase::try_from(PHRASE).unwrap().as_bytes(), PHRASE); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>empty_valid() { |
| <span class="kw">const </span>PHRASE: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8] = <span class="string">b""</span>; |
| <span class="macro">assert_eq!</span>(ReasonPhrase::from_static(PHRASE).as_bytes(), PHRASE); |
| <span class="macro">assert_eq!</span>(ReasonPhrase::try_from(PHRASE).unwrap().as_bytes(), PHRASE); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>obs_text_valid() { |
| <span class="kw">const </span>PHRASE: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8] = <span class="string">b"hyp\xe9r"</span>; |
| <span class="macro">assert_eq!</span>(ReasonPhrase::from_static(PHRASE).as_bytes(), PHRASE); |
| <span class="macro">assert_eq!</span>(ReasonPhrase::try_from(PHRASE).unwrap().as_bytes(), PHRASE); |
| } |
| |
| <span class="kw">const </span>NEWLINE_PHRASE: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8] = <span class="string">b"hyp\ner"</span>; |
| |
| <span class="attribute">#[test] |
| #[should_panic] |
| </span><span class="kw">fn </span>newline_invalid_panic() { |
| ReasonPhrase::from_static(NEWLINE_PHRASE); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>newline_invalid_err() { |
| <span class="macro">assert!</span>(ReasonPhrase::try_from(NEWLINE_PHRASE).is_err()); |
| } |
| |
| <span class="kw">const </span>CR_PHRASE: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8] = <span class="string">b"hyp\rer"</span>; |
| |
| <span class="attribute">#[test] |
| #[should_panic] |
| </span><span class="kw">fn </span>cr_invalid_panic() { |
| ReasonPhrase::from_static(CR_PHRASE); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>cr_invalid_err() { |
| <span class="macro">assert!</span>(ReasonPhrase::try_from(CR_PHRASE).is_err()); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |