blob: 6e804a35798111119c1dd39b6f41202394c2d573 [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/body/length.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>length.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="attribute">#[derive(Clone, Copy, PartialEq, Eq)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>DecodedLength(u64);
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;http1&quot;</span>, feature = <span class="string">&quot;http2&quot;</span>))]
</span><span class="kw">impl </span>From&lt;<span class="prelude-ty">Option</span>&lt;u64&gt;&gt; <span class="kw">for </span>DecodedLength {
<span class="kw">fn </span>from(len: <span class="prelude-ty">Option</span>&lt;u64&gt;) -&gt; <span class="self">Self </span>{
len.and_then(|len| {
<span class="comment">// If the length is u64::MAX, oh well, just reported chunked.
</span><span class="self">Self</span>::checked_new(len).ok()
})
.unwrap_or(DecodedLength::CHUNKED)
}
}
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;http1&quot;</span>, feature = <span class="string">&quot;http2&quot;</span>, test))]
</span><span class="kw">const </span>MAX_LEN: u64 = std::u64::MAX - <span class="number">2</span>;
<span class="kw">impl </span>DecodedLength {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>CLOSE_DELIMITED: DecodedLength = DecodedLength(::std::u64::MAX);
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>CHUNKED: DecodedLength = DecodedLength(::std::u64::MAX - <span class="number">1</span>);
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>ZERO: DecodedLength = DecodedLength(<span class="number">0</span>);
<span class="attribute">#[cfg(test)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(len: u64) -&gt; <span class="self">Self </span>{
<span class="macro">debug_assert!</span>(len &lt;= MAX_LEN);
DecodedLength(len)
}
<span class="doccomment">/// Takes the length as a content-length without other checks.
///
/// Should only be called if previously confirmed this isn&#39;t
/// CLOSE_DELIMITED or CHUNKED.
</span><span class="attribute">#[inline]
#[cfg(feature = <span class="string">&quot;http1&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>danger_len(<span class="self">self</span>) -&gt; u64 {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.<span class="number">0 </span>&lt; <span class="self">Self</span>::CHUNKED.<span class="number">0</span>);
<span class="self">self</span>.<span class="number">0
</span>}
<span class="doccomment">/// Converts to an Option&lt;u64&gt; representing a Known or Unknown length.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>into_opt(<span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;u64&gt; {
<span class="kw">match </span><span class="self">self </span>{
DecodedLength::CHUNKED | DecodedLength::CLOSE_DELIMITED =&gt; <span class="prelude-val">None</span>,
DecodedLength(known) =&gt; <span class="prelude-val">Some</span>(known),
}
}
<span class="doccomment">/// Checks the `u64` is within the maximum allowed for content-length.
</span><span class="attribute">#[cfg(any(feature = <span class="string">&quot;http1&quot;</span>, feature = <span class="string">&quot;http2&quot;</span>))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>checked_new(len: u64) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, <span class="kw">crate</span>::error::Parse&gt; {
<span class="kw">use </span>tracing::warn;
<span class="kw">if </span>len &lt;= MAX_LEN {
<span class="prelude-val">Ok</span>(DecodedLength(len))
} <span class="kw">else </span>{
<span class="macro">warn!</span>(<span class="string">&quot;content-length bigger than maximum: {} &gt; {}&quot;</span>, len, MAX_LEN);
<span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::Parse::TooLarge)
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>sub_if(<span class="kw-2">&amp;mut </span><span class="self">self</span>, amt: u64) {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
DecodedLength::CHUNKED | DecodedLength::CLOSE_DELIMITED =&gt; (),
DecodedLength(<span class="kw-2">ref mut </span>known) =&gt; {
<span class="kw-2">*</span>known -= amt;
}
}
}
<span class="doccomment">/// Returns whether this represents an exact length.
///
/// This includes 0, which of course is an exact known length.
///
/// It would return false if &quot;chunked&quot; or otherwise size-unknown.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_exact(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.<span class="number">0 </span>&lt;= MAX_LEN
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DecodedLength {
<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 {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
DecodedLength::CLOSE_DELIMITED =&gt; f.write_str(<span class="string">&quot;CLOSE_DELIMITED&quot;</span>),
DecodedLength::CHUNKED =&gt; f.write_str(<span class="string">&quot;CHUNKED&quot;</span>),
DecodedLength(n) =&gt; f.debug_tuple(<span class="string">&quot;DecodedLength&quot;</span>).field(<span class="kw-2">&amp;</span>n).finish(),
}
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>DecodedLength {
<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 {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
DecodedLength::CLOSE_DELIMITED =&gt; f.write_str(<span class="string">&quot;close-delimited&quot;</span>),
DecodedLength::CHUNKED =&gt; f.write_str(<span class="string">&quot;chunked encoding&quot;</span>),
DecodedLength::ZERO =&gt; f.write_str(<span class="string">&quot;empty&quot;</span>),
DecodedLength(n) =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;content-length ({} bytes)&quot;</span>, n),
}
}
}
<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>sub_if_known() {
<span class="kw">let </span><span class="kw-2">mut </span>len = DecodedLength::new(<span class="number">30</span>);
len.sub_if(<span class="number">20</span>);
<span class="macro">assert_eq!</span>(len.<span class="number">0</span>, <span class="number">10</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>sub_if_chunked() {
<span class="kw">let </span><span class="kw-2">mut </span>len = DecodedLength::CHUNKED;
len.sub_if(<span class="number">20</span>);
<span class="macro">assert_eq!</span>(len, DecodedLength::CHUNKED);
}
}
</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>