| <!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-body-0.4.5/src/size_hint.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>size_hint.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_body/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_body/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::u64; |
| |
| <span class="doccomment">/// A `Body` size hint |
| /// |
| /// The default implementation returns: |
| /// |
| /// * 0 for `lower` |
| /// * `None` for `upper`. |
| </span><span class="attribute">#[derive(Debug, Default, Clone)] |
| </span><span class="kw">pub struct </span>SizeHint { |
| lower: u64, |
| upper: <span class="prelude-ty">Option</span><u64>, |
| } |
| |
| <span class="kw">impl </span>SizeHint { |
| <span class="doccomment">/// Returns a new `SizeHint` with default values |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new() -> SizeHint { |
| SizeHint::default() |
| } |
| |
| <span class="doccomment">/// Returns a new `SizeHint` with both upper and lower bounds set to the |
| /// given value. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>with_exact(value: u64) -> SizeHint { |
| SizeHint { |
| lower: value, |
| upper: <span class="prelude-val">Some</span>(value), |
| } |
| } |
| |
| <span class="doccomment">/// Returns the lower bound of data that the `Body` will yield before |
| /// completing. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>lower(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.lower |
| } |
| |
| <span class="doccomment">/// Set the value of the `lower` hint. |
| /// |
| /// # Panics |
| /// |
| /// The function panics if `value` is greater than `upper`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_lower(<span class="kw-2">&mut </span><span class="self">self</span>, value: u64) { |
| <span class="macro">assert!</span>(value <= <span class="self">self</span>.upper.unwrap_or(u64::MAX)); |
| <span class="self">self</span>.lower = value; |
| } |
| |
| <span class="doccomment">/// Returns the upper bound of data the `Body` will yield before |
| /// completing, or `None` if the value is unknown. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>upper(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="self">self</span>.upper |
| } |
| |
| <span class="doccomment">/// Set the value of the `upper` hint value. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if `value` is less than `lower`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_upper(<span class="kw-2">&mut </span><span class="self">self</span>, value: u64) { |
| <span class="macro">assert!</span>(value >= <span class="self">self</span>.lower, <span class="string">"`value` is less than than `lower`"</span>); |
| |
| <span class="self">self</span>.upper = <span class="prelude-val">Some</span>(value); |
| } |
| |
| <span class="doccomment">/// Returns the exact size of data that will be yielded **if** the |
| /// `lower` and `upper` bounds are equal. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>exact(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="kw">if </span><span class="prelude-val">Some</span>(<span class="self">self</span>.lower) == <span class="self">self</span>.upper { |
| <span class="self">self</span>.upper |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set the value of the `lower` and `upper` bounds to exactly the same. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>set_exact(<span class="kw-2">&mut </span><span class="self">self</span>, value: u64) { |
| <span class="self">self</span>.lower = value; |
| <span class="self">self</span>.upper = <span class="prelude-val">Some</span>(value); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http_body" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |