blob: 7b5623b0809274b0110761c76e76ca3d0893f799 [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/integer-encoding-1.1.7/src/writer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>writer.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="../../integer_encoding/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="../../integer_encoding/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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io::{<span class="prelude-ty">Result</span>, Write};
<span class="kw">use </span><span class="kw">crate</span>::fixed::FixedInt;
<span class="kw">use </span><span class="kw">crate</span>::varint::VarInt;
<span class="attribute">#[cfg(feature = <span class="string">&quot;tokio_async&quot;</span>)]
</span><span class="kw">use </span>tokio::{io::AsyncWriteExt, prelude::<span class="kw-2">*</span>};
<span class="attribute">#[cfg(feature = <span class="string">&quot;futures_async&quot;</span>)]
</span><span class="kw">use </span>futures_util::{io::AsyncWriteExt, io::AsyncWrite};
<span class="doccomment">/// A trait for writing integers in VarInt encoding to any `Write` type. This packs encoding and
/// writing into one step.
</span><span class="kw">pub trait </span>VarIntWriter {
<span class="kw">fn </span>write_varint&lt;VI: VarInt&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: VI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt;;
}
<span class="doccomment">/// Like VarIntWriter, but asynchronous.
</span><span class="attribute">#[cfg(any(feature = <span class="string">&quot;tokio_async&quot;</span>, feature = <span class="string">&quot;futures_async&quot;</span>))]
#[async_trait::async_trait]
</span><span class="kw">pub trait </span>VarIntAsyncWriter {
<span class="doccomment">/// Write a VarInt integer to an asynchronous writer.
</span><span class="kw">async fn </span>write_varint_async&lt;VI: VarInt + Send&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: VI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt;;
}
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;tokio_async&quot;</span>, feature = <span class="string">&quot;futures_async&quot;</span>))]
#[async_trait::async_trait]
</span><span class="kw">impl</span>&lt;AW: AsyncWrite + Send + Unpin&gt; VarIntAsyncWriter <span class="kw">for </span>AW {
<span class="kw">async fn </span>write_varint_async&lt;VI: VarInt + Send&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: VI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0 </span><span class="kw">as </span>u8; <span class="number">10</span>];
<span class="kw">let </span>b = n.encode_var(<span class="kw-2">&amp;mut </span>buf);
<span class="self">self</span>.write_all(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..b]).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(b)
}
}
<span class="kw">impl</span>&lt;Inner: Write&gt; VarIntWriter <span class="kw">for </span>Inner {
<span class="kw">fn </span>write_varint&lt;VI: VarInt&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: VI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0 </span><span class="kw">as </span>u8; <span class="number">10</span>];
<span class="kw">let </span>used = n.encode_var(<span class="kw-2">&amp;mut </span>buf[..]);
<span class="self">self</span>.write_all(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..used])<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(used)
}
}
<span class="doccomment">/// A trait for writing integers without encoding (i.e. `FixedInt`) to any `Write` type.
</span><span class="kw">pub trait </span>FixedIntWriter {
<span class="kw">fn </span>write_fixedint&lt;FI: FixedInt&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: FI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt;;
}
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;tokio_async&quot;</span>, feature = <span class="string">&quot;futures_async&quot;</span>))]
#[async_trait::async_trait]
</span><span class="kw">pub trait </span>FixedIntAsyncWriter {
<span class="kw">async fn </span>write_fixedint_async&lt;FI: FixedInt + Send&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: FI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt;;
}
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;tokio_async&quot;</span>, feature = <span class="string">&quot;futures_async&quot;</span>))]
#[async_trait::async_trait]
</span><span class="kw">impl</span>&lt;AW: AsyncWrite + Unpin + Send&gt; FixedIntAsyncWriter <span class="kw">for </span>AW {
<span class="kw">async fn </span>write_fixedint_async&lt;FI: FixedInt + Send&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: FI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0 </span><span class="kw">as </span>u8; <span class="number">8</span>];
n.encode_fixed(<span class="kw-2">&amp;mut </span>buf[<span class="number">0</span>..FI::required_space()]);
<span class="self">self</span>.write_all(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..FI::required_space()]).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FI::REQUIRED_SPACE)
}
}
<span class="kw">impl</span>&lt;W: Write&gt; FixedIntWriter <span class="kw">for </span>W {
<span class="kw">fn </span>write_fixedint&lt;FI: FixedInt&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: FI) -&gt; <span class="prelude-ty">Result</span>&lt;usize&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0 </span><span class="kw">as </span>u8; <span class="number">8</span>];
n.encode_fixed(<span class="kw-2">&amp;mut </span>buf[<span class="number">0</span>..FI::required_space()]);
<span class="self">self</span>.write_all(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..FI::required_space()])<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FI::REQUIRED_SPACE)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="integer_encoding" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>