pnmixer-rust/deflate/fn.deflate_bytes_zlib_conf.html

124 lines
5.7 KiB
HTML
Raw Normal View History

2017-07-14 23:24:09 +00:00
<!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">
2017-07-14 23:30:16 +00:00
<meta name="description" content="API documentation for the Rust `deflate_bytes_zlib_conf` fn in crate `deflate`.">
<meta name="keywords" content="rust, rustlang, rust-lang, deflate_bytes_zlib_conf">
2017-07-14 23:24:09 +00:00
2017-07-14 23:30:16 +00:00
<title>deflate::deflate_bytes_zlib_conf - Rust</title>
2017-07-14 23:24:09 +00:00
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
2017-07-14 23:30:16 +00:00
<body class="rustdoc fn">
2017-07-14 23:24:09 +00:00
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
2017-07-14 23:30:16 +00:00
<p class='location'><a href='index.html'>deflate</a></p><script>window.sidebarCurrent = {name: 'deflate_bytes_zlib_conf', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
2017-07-14 23:24:09 +00:00
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
2017-07-14 23:30:16 +00:00
<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>deflate</a>::<wbr><a class="fn" href=''>deflate_bytes_zlib_conf</a></span><span class='out-of-band'><span id='render-detail'>
2017-07-14 23:24:09 +00:00
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
2017-07-14 23:30:16 +00:00
</span><a class='srclink' href='../src/deflate/lib.rs.html#187-204' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn deflate_bytes_zlib_conf&lt;O:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="../deflate/struct.CompressionOptions.html" title="struct deflate::CompressionOptions">CompressionOptions</a>&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;input: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</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>, <br>&nbsp;&nbsp;&nbsp;&nbsp;options: O<br>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</pre><div class='docblock'><p>Compress the given slice of bytes with DEFLATE compression, including a zlib header and trailer.</p>
<p>Returns a <code>Vec&lt;u8&gt;</code> of the compressed data.</p>
<p>Zlib dictionaries are not yet suppored.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">deflate</span>::{<span class="ident">deflate_bytes_zlib_conf</span>, <span class="ident">Compression</span>};
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b&quot;This is some test data&quot;</span>;
<span class="kw">let</span> <span class="ident">compressed_data</span> <span class="op">=</span> <span class="ident">deflate_bytes_zlib_conf</span>(<span class="ident">data</span>, <span class="ident">Compression</span>::<span class="ident">Best</span>);</pre>
2017-07-14 23:24:09 +00:00
</div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
2017-07-14 23:30:16 +00:00
window.currentCrate = "deflate";
2017-07-14 23:24:09 +00:00
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>