| <!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/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/common/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="../../tantivy_common/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="../../tantivy_common/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::io::{<span class="self">self</span>, BufWriter, Write}; |
| |
| <span class="kw">pub struct </span>CountingWriter<W> { |
| underlying: W, |
| written_bytes: u64, |
| } |
| |
| <span class="kw">impl</span><W: Write> CountingWriter<W> { |
| <span class="kw">pub fn </span>wrap(underlying: W) -> CountingWriter<W> { |
| CountingWriter { |
| underlying, |
| written_bytes: <span class="number">0</span>, |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>written_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.written_bytes |
| } |
| |
| <span class="doccomment">/// Returns the underlying write object. |
| /// Note that this method does not trigger any flushing. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>finish(<span class="self">self</span>) -> W { |
| <span class="self">self</span>.underlying |
| } |
| } |
| |
| <span class="kw">impl</span><W: Write> Write <span class="kw">for </span>CountingWriter<W> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="kw">let </span>written_size = <span class="self">self</span>.underlying.write(buf)<span class="question-mark">?</span>; |
| <span class="self">self</span>.written_bytes += written_size <span class="kw">as </span>u64; |
| <span class="prelude-val">Ok</span>(written_size) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>write_all(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<()> { |
| <span class="self">self</span>.underlying.write_all(buf)<span class="question-mark">?</span>; |
| <span class="self">self</span>.written_bytes += buf.len() <span class="kw">as </span>u64; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.underlying.flush() |
| } |
| } |
| |
| <span class="kw">impl</span><W: TerminatingWrite> TerminatingWrite <span class="kw">for </span>CountingWriter<W> { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>terminate_ref(<span class="kw-2">&mut </span><span class="self">self</span>, token: AntiCallToken) -> io::Result<()> { |
| <span class="self">self</span>.underlying.terminate_ref(token) |
| } |
| } |
| |
| <span class="doccomment">/// Struct used to prevent from calling |
| /// [`terminate_ref`](TerminatingWrite::terminate_ref) directly |
| /// |
| /// The point is that while the type is public, it cannot be built by anyone |
| /// outside of this module. |
| </span><span class="kw">pub struct </span>AntiCallToken(()); |
| |
| <span class="doccomment">/// Trait used to indicate when no more write need to be done on a writer |
| </span><span class="kw">pub trait </span>TerminatingWrite: Write + Send + Sync { |
| <span class="doccomment">/// Indicate that the writer will no longer be used. Internally call terminate_ref. |
| </span><span class="kw">fn </span>terminate(<span class="kw-2">mut </span><span class="self">self</span>) -> io::Result<()> |
| <span class="kw">where </span><span class="self">Self</span>: Sized { |
| <span class="self">self</span>.terminate_ref(AntiCallToken(())) |
| } |
| |
| <span class="doccomment">/// You should implement this function to define custom behavior. |
| /// This function should flush any buffer it may hold. |
| </span><span class="kw">fn </span>terminate_ref(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: AntiCallToken) -> io::Result<()>; |
| } |
| |
| <span class="kw">impl</span><W: TerminatingWrite + <span class="question-mark">?</span>Sized> TerminatingWrite <span class="kw">for </span>Box<W> { |
| <span class="kw">fn </span>terminate_ref(<span class="kw-2">&mut </span><span class="self">self</span>, token: AntiCallToken) -> io::Result<()> { |
| <span class="self">self</span>.as_mut().terminate_ref(token) |
| } |
| } |
| |
| <span class="kw">impl</span><W: TerminatingWrite> TerminatingWrite <span class="kw">for </span>BufWriter<W> { |
| <span class="kw">fn </span>terminate_ref(<span class="kw-2">&mut </span><span class="self">self</span>, a: AntiCallToken) -> io::Result<()> { |
| <span class="self">self</span>.flush()<span class="question-mark">?</span>; |
| <span class="self">self</span>.get_mut().terminate_ref(a) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> TerminatingWrite <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Vec<u8> { |
| <span class="kw">fn </span>terminate_ref(<span class="kw-2">&mut </span><span class="self">self</span>, _a: AntiCallToken) -> io::Result<()> { |
| <span class="self">self</span>.flush() |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| |
| <span class="kw">use </span>std::io::Write; |
| |
| <span class="kw">use </span><span class="kw">super</span>::CountingWriter; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_counting_writer() { |
| <span class="kw">let </span>buffer: Vec<u8> = <span class="macro">vec!</span>[]; |
| <span class="kw">let </span><span class="kw-2">mut </span>counting_writer = CountingWriter::wrap(buffer); |
| <span class="kw">let </span>bytes = (<span class="number">0u8</span>..<span class="number">10u8</span>).collect::<Vec<u8>>(); |
| counting_writer.write_all(<span class="kw-2">&</span>bytes).unwrap(); |
| <span class="kw">let </span>len = counting_writer.written_bytes(); |
| <span class="kw">let </span>buffer_restituted: Vec<u8> = counting_writer.finish(); |
| <span class="macro">assert_eq!</span>(len, <span class="number">10u64</span>); |
| <span class="macro">assert_eq!</span>(buffer_restituted.len(), <span class="number">10</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy_common" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
