blob: a93b59def4a1bf4483ba2891cd800905021016b6 [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/hyper-0.14.26/src/proto/h1/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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>
</pre><pre class="rust"><code><span class="attribute">#[cfg(all(feature = <span class="string">&quot;server&quot;</span>, feature = <span class="string">&quot;runtime&quot;</span>))]
</span><span class="kw">use </span>std::{pin::Pin, time::Duration};
<span class="kw">use </span>bytes::BytesMut;
<span class="kw">use </span>http::{HeaderMap, Method};
<span class="kw">use </span>httparse::ParserConfig;
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;server&quot;</span>, feature = <span class="string">&quot;runtime&quot;</span>))]
</span><span class="kw">use </span>tokio::time::Sleep;
<span class="kw">use </span><span class="kw">crate</span>::body::DecodedLength;
<span class="kw">use </span><span class="kw">crate</span>::proto::{BodyLength, MessageHead};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::conn::Conn;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::decode::Decoder;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::dispatch::Dispatcher;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::encode::{EncodedBuf, Encoder};
<span class="comment">//TODO: move out of h1::io
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::io::MINIMUM_MAX_BUFFER_SIZE;
<span class="kw">mod </span>conn;
<span class="kw">mod </span>decode;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>dispatch;
<span class="kw">mod </span>encode;
<span class="kw">mod </span>io;
<span class="kw">mod </span>role;
<span class="macro">cfg_client! </span>{
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>ClientTransaction = role::Client;
}
<span class="macro">cfg_server! </span>{
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>ServerTransaction = role::Server;
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>Http1Transaction {
<span class="kw">type </span>Incoming;
<span class="kw">type </span>Outgoing: Default;
<span class="kw">const </span>LOG: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str;
<span class="kw">fn </span>parse(bytes: <span class="kw-2">&amp;mut </span>BytesMut, ctx: ParseContext&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; ParseResult&lt;<span class="self">Self</span>::Incoming&gt;;
<span class="kw">fn </span>encode(enc: Encode&lt;<span class="lifetime">&#39;_</span>, <span class="self">Self</span>::Outgoing&gt;, dst: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) -&gt; <span class="kw">crate</span>::Result&lt;Encoder&gt;;
<span class="kw">fn </span>on_error(err: <span class="kw-2">&amp;</span><span class="kw">crate</span>::Error) -&gt; <span class="prelude-ty">Option</span>&lt;MessageHead&lt;<span class="self">Self</span>::Outgoing&gt;&gt;;
<span class="kw">fn </span>is_client() -&gt; bool {
!<span class="self">Self</span>::is_server()
}
<span class="kw">fn </span>is_server() -&gt; bool {
!<span class="self">Self</span>::is_client()
}
<span class="kw">fn </span>should_error_on_parse_eof() -&gt; bool {
<span class="self">Self</span>::is_client()
}
<span class="kw">fn </span>should_read_first() -&gt; bool {
<span class="self">Self</span>::is_server()
}
<span class="kw">fn </span>update_date() {}
}
<span class="doccomment">/// Result newtype for Http1Transaction::parse.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>ParseResult&lt;T&gt; = <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;ParsedMessage&lt;T&gt;&gt;, <span class="kw">crate</span>::error::Parse&gt;;
<span class="attribute">#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>ParsedMessage&lt;T&gt; {
head: MessageHead&lt;T&gt;,
decode: DecodedLength,
expect_continue: bool,
keep_alive: bool,
wants_upgrade: bool,
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>ParseContext&lt;<span class="lifetime">&#39;a</span>&gt; {
cached_headers: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span>&lt;HeaderMap&gt;,
req_method: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span>&lt;Method&gt;,
h1_parser_config: ParserConfig,
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;server&quot;</span>, feature = <span class="string">&quot;runtime&quot;</span>))]
</span>h1_header_read_timeout: <span class="prelude-ty">Option</span>&lt;Duration&gt;,
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;server&quot;</span>, feature = <span class="string">&quot;runtime&quot;</span>))]
</span>h1_header_read_timeout_fut: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span>&lt;Pin&lt;Box&lt;Sleep&gt;&gt;&gt;,
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;server&quot;</span>, feature = <span class="string">&quot;runtime&quot;</span>))]
</span>h1_header_read_timeout_running: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>bool,
preserve_header_case: bool,
<span class="attribute">#[cfg(feature = <span class="string">&quot;ffi&quot;</span>)]
</span>preserve_header_order: bool,
h09_responses: bool,
<span class="attribute">#[cfg(feature = <span class="string">&quot;ffi&quot;</span>)]
</span>on_informational: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span>&lt;<span class="kw">crate</span>::ffi::OnInformational&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;ffi&quot;</span>)]
</span>raw_headers: bool,
}
<span class="doccomment">/// Passed to Http1Transaction::encode
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Encode&lt;<span class="lifetime">&#39;a</span>, T&gt; {
head: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>MessageHead&lt;T&gt;,
body: <span class="prelude-ty">Option</span>&lt;BodyLength&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;server&quot;</span>)]
</span>keep_alive: bool,
req_method: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span>&lt;Method&gt;,
title_case_headers: bool,
}
<span class="doccomment">/// Extra flags that a request &quot;wants&quot;, like expect-continue or upgrades.
</span><span class="attribute">#[derive(Clone, Copy, Debug)]
</span><span class="kw">struct </span>Wants(u8);
<span class="kw">impl </span>Wants {
<span class="kw">const </span>EMPTY: Wants = Wants(<span class="number">0b00</span>);
<span class="kw">const </span>EXPECT: Wants = Wants(<span class="number">0b01</span>);
<span class="kw">const </span>UPGRADE: Wants = Wants(<span class="number">0b10</span>);
<span class="attribute">#[must_use]
</span><span class="kw">fn </span>add(<span class="self">self</span>, other: Wants) -&gt; Wants {
Wants(<span class="self">self</span>.<span class="number">0 </span>| other.<span class="number">0</span>)
}
<span class="kw">fn </span>contains(<span class="kw-2">&amp;</span><span class="self">self</span>, other: Wants) -&gt; bool {
(<span class="self">self</span>.<span class="number">0 </span>&amp; other.<span class="number">0</span>) == other.<span class="number">0
</span>}
}
</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>