17 lines
11 KiB
HTML
17 lines
11 KiB
HTML
<!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="The [`Lz77Encode`] trait defines the interface of LZ77 encoding algorithm."><meta name="keywords" content="rust, rustlang, rust-lang, Lz77Encode"><title>Lz77Encode in libflate_lz77 - Rust</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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../libflate_lz77/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait Lz77Encode</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.encode">encode</a><a href="#tymethod.flush">flush</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.compression_level">compression_level</a><a href="#method.window_size">window_size</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">libflate_lz77</a></h2><div id="sidebar-vars" data-name="Lz77Encode" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../libflate_lz77/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">libflate_lz77</a>::<wbr><a class="trait" href="#">Lz77Encode</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/libflate_lz77/lib.rs.html#76-100" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Lz77Encode {
|
||
fn <a href="#tymethod.encode" class="fnname">encode</a><S>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>, sink: S)<br> <span class="where">where<br> S: <a class="trait" href="trait.Sink.html" title="trait libflate_lz77::Sink">Sink</a></span>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.flush" class="fnname">flush</a><S>(&mut self, sink: S)<br> <span class="where">where<br> S: <a class="trait" href="trait.Sink.html" title="trait libflate_lz77::Sink">Sink</a></span>;
|
||
|
||
fn <a href="#method.compression_level" class="fnname">compression_level</a>(&self) -> <a class="enum" href="enum.CompressionLevel.html" title="enum libflate_lz77::CompressionLevel">CompressionLevel</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.window_size" class="fnname">window_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u16.html">u16</a> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <a href="trait.Lz77Encode.html" title="Lz77Encode"><code>Lz77Encode</code></a> trait defines the interface of LZ77 encoding algorithm.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.encode" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/libflate_lz77/lib.rs.html#78-80" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.encode" class="fnname">encode</a><S>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>, sink: S) <span class="where fmt-newline">where<br> S: <a class="trait" href="trait.Sink.html" title="trait libflate_lz77::Sink">Sink</a>, </span></h4></div></summary><div class="docblock"><p>Encodes a buffer and writes result LZ77 codes to <code>sink</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.flush" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/libflate_lz77/lib.rs.html#83-85" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.flush" class="fnname">flush</a><S>(&mut self, sink: S) <span class="where fmt-newline">where<br> S: <a class="trait" href="trait.Sink.html" title="trait libflate_lz77::Sink">Sink</a>, </span></h4></div></summary><div class="docblock"><p>Flushes the encoder, ensuring that all intermediately buffered codes are consumed by <code>sink</code>.</p>
|
||
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.compression_level" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/libflate_lz77/lib.rs.html#90-92" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.compression_level" class="fnname">compression_level</a>(&self) -> <a class="enum" href="enum.CompressionLevel.html" title="enum libflate_lz77::CompressionLevel">CompressionLevel</a></h4></div></summary><div class="docblock"><p>Returns the compression level of the encoder.</p>
|
||
<p>If the implementation is omitted, <a href="enum.CompressionLevel.html#variant.Balance" title="CompressionLevel::Balance"><code>CompressionLevel::Balance</code></a> will be returned.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.window_size" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/libflate_lz77/lib.rs.html#97-99" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.window_size" class="fnname">window_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u16.html">u16</a></h4></div></summary><div class="docblock"><p>Returns the window size of the encoder.</p>
|
||
<p>If the implementation is omitted, <a href="constant.MAX_WINDOW_SIZE.html" title="MAX_WINDOW_SIZE"><code>MAX_WINDOW_SIZE</code></a> will be returned.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-Lz77Encode" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/libflate_lz77/default.rs.html#63-117" title="goto source code">[src]</a></div><a href="#impl-Lz77Encode" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Lz77Encode.html" title="trait libflate_lz77::Lz77Encode">Lz77Encode</a> for <a class="struct" href="struct.DefaultLz77Encoder.html" title="struct libflate_lz77::DefaultLz77Encoder">DefaultLz77Encoder</a></h3></div><div id="impl-Lz77Encode-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/libflate_lz77/lib.rs.html#123-141" title="goto source code">[src]</a></div><a href="#impl-Lz77Encode-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Lz77Encode.html" title="trait libflate_lz77::Lz77Encode">Lz77Encode</a> for <a class="struct" href="struct.NoCompressionLz77Encoder.html" title="struct libflate_lz77::NoCompressionLz77Encoder">NoCompressionLz77Encoder</a></h3></div></div><script type="text/javascript" src="../implementors/libflate_lz77/trait.Lz77Encode.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="libflate_lz77" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |