Update docs
This commit is contained in:
@@ -48,7 +48,7 @@
|
||||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||||
[<span class='inner'>−</span>]
|
||||
</a>
|
||||
</span><a class='srclink' href='../../src/deflate/writer.rs.html#166-170' title='goto source code'>[src]</a></span></h1>
|
||||
</span><a class='srclink' href='../../src/deflate/writer.rs.html#186-190' title='goto source code'>[src]</a></span></h1>
|
||||
<pre class='rust struct'>pub struct ZlibEncoder<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> { /* fields omitted */ }</pre><div class='docblock'><p>A Zlib encoder/compressor.</p>
|
||||
|
||||
<p>A struct implementing a <a href="https://doc.rust-lang.org/std/io/trait.Write.html"><code>Write</code></a> interface that takes unencoded data and compresses it to
|
||||
@@ -63,9 +63,9 @@ the provided writer using DEFLATE compression with Zlib headers and trailers.</p
|
||||
|
||||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"This is some test data"</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">encoder</span> <span class="op">=</span> <span class="ident">ZlibEncoder</span>::<span class="ident">new</span>(<span class="ident">Vec</span>::<span class="ident">new</span>(), <span class="ident">Compression</span>::<span class="ident">Default</span>);
|
||||
<span class="ident">encoder</span>.<span class="ident">write_all</span>(<span class="ident">data</span>).<span class="ident">unwrap</span>();
|
||||
<span class="kw">let</span> <span class="ident">compressed_data</span> <span class="op">=</span> <span class="ident">encoder</span>.<span class="ident">finish</span>().<span class="ident">unwrap</span>();</pre>
|
||||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/deflate/writer.rs.html#172-232' title='goto source code'>[src]</a></span></h3>
|
||||
<span class="ident">encoder</span>.<span class="ident">write_all</span>(<span class="ident">data</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">compressed_data</span> <span class="op">=</span> <span class="ident">encoder</span>.<span class="ident">finish</span>()<span class="question-mark">?</span>;</pre>
|
||||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/deflate/writer.rs.html#192-252' title='goto source code'>[src]</a></span></h3>
|
||||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a><O: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../deflate/struct.CompressionOptions.html" title="struct deflate::CompressionOptions">CompressionOptions</a>>>(writer: W, options: O) -> <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span></h4>
|
||||
<div class='docblock'><p>Create a new <code>ZlibEncoder</code> using the provided compression options.</p>
|
||||
</div><h4 id='method.finish' class="method"><span id='finish.v' class='invisible'><code>fn <a href='#method.finish' class='fnname'>finish</a>(self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><W></code></span></h4>
|
||||
@@ -76,7 +76,7 @@ and return the contained writer if writing succeeds.</p>
|
||||
with a new one, returning the old one.</p>
|
||||
</div><h4 id='method.checksum' class="method"><span id='checksum.v' class='invisible'><code>fn <a href='#method.checksum' class='fnname'>checksum</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h4>
|
||||
<div class='docblock'><p>Return the adler32 checksum of the currently consumed data.</p>
|
||||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/deflate/writer.rs.html#234-258' title='goto source code'>[src]</a></span></h3>
|
||||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/deflate/writer.rs.html#254-278' title='goto source code'>[src]</a></span></h3>
|
||||
<div class='impl-items'><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/io/trait.Write.html#tymethod.write' class='fnname'>write</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span></h4>
|
||||
<div class='docblock'><p>Write a buffer into this object, returning how many bytes were written. <a href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html#tymethod.write">Read more</a></p>
|
||||
</div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/io/trait.Write.html#tymethod.flush' class='fnname'>flush</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
||||
@@ -91,7 +91,7 @@ the writer.</p>
|
||||
<div class='docblock'><p>Writes a formatted string into this writer, returning any error encountered. <a href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html#method.write_fmt">Read more</a></p>
|
||||
</div><h4 id='method.by_ref' class="method"><span id='by_ref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/io/trait.Write.html#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> &mut Self</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
|
||||
<div class='docblock'><p>Creates a "by reference" adaptor for this instance of <code>Write</code>. <a href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html#method.by_ref">Read more</a></p>
|
||||
</div></div><h3 class='impl'><span class='in-band'><code>impl<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/deflate/writer.rs.html#260-271' title='goto source code'>[src]</a></span></h3>
|
||||
</div></div><h3 class='impl'><span class='in-band'><code>impl<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../deflate/write/struct.ZlibEncoder.html" title="struct deflate::write::ZlibEncoder">ZlibEncoder</a><W></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/deflate/writer.rs.html#280-291' title='goto source code'>[src]</a></span></h3>
|
||||
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span></h4>
|
||||
<div class='docblock'><p>When the encoder is dropped, output the rest of the data.</p>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user