14 lines
6.1 KiB
HTML
14 lines
6.1 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="A pure rust replacement for the miniz DEFLATE/zlib encoder/decoder. Used a rust back-end for the flate2 crate."><title>miniz_oxide - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="miniz_oxide" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Crate miniz_oxide</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../miniz_oxide/index.html">miniz_<wbr>oxide</a><span class="version">0.8.9</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a><ul><li><a href="#simple-compressiondecompression" title="Simple compression/decompression:">Simple compression/decompression:</a></li></ul></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>miniz_<wbr>oxide</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/miniz_oxide/lib.rs.html#1-222">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A pure rust replacement for the <a href="https://github.com/richgel999/miniz">miniz</a>
|
|
DEFLATE/zlib encoder/decoder.
|
|
Used a rust back-end for the
|
|
<a href="https://github.com/alexcrichton/flate2-rs">flate2</a> crate.</p>
|
|
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2><h3 id="simple-compressiondecompression"><a class="doc-anchor" href="#simple-compressiondecompression">§</a>Simple compression/decompression:</h3>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
|
|
<span class="kw">use </span>miniz_oxide::inflate::decompress_to_vec;
|
|
<span class="kw">use </span>miniz_oxide::deflate::compress_to_vec;
|
|
|
|
<span class="kw">fn </span>roundtrip(data: <span class="kw-2">&</span>[u8]) {
|
|
<span class="kw">let </span>compressed = compress_to_vec(data, <span class="number">6</span>);
|
|
<span class="kw">let </span>decompressed = decompress_to_vec(compressed.as_slice()).expect(<span class="string">"Failed to decompress!"</span>);
|
|
}
|
|
</code></pre></div></div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="deflate/index.html" title="mod miniz_oxide::deflate">deflate</a></dt><dd>This module contains functionality for compression.</dd><dt><a class="mod" href="inflate/index.html" title="mod miniz_oxide::inflate">inflate</a></dt><dd>This module contains functionality for decompression.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.StreamResult.html" title="struct miniz_oxide::StreamResult">Stream<wbr>Result</a></dt><dd>A structure containing the result of a call to the inflate or deflate streaming functions.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.DataFormat.html" title="enum miniz_oxide::DataFormat">Data<wbr>Format</a></dt><dd>How compressed data is wrapped.</dd><dt><a class="enum" href="enum.MZError.html" title="enum miniz_oxide::MZError">MZError</a></dt><dd>A list of miniz failed status codes.</dd><dt><a class="enum" href="enum.MZFlush.html" title="enum miniz_oxide::MZFlush">MZFlush</a></dt><dd>A list of flush types.</dd><dt><a class="enum" href="enum.MZStatus.html" title="enum miniz_oxide::MZStatus">MZStatus</a></dt><dd>A list of miniz successful status codes.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.MZResult.html" title="type miniz_oxide::MZResult">MZResult</a></dt><dd><code>Result</code> alias for all miniz status codes both successful and failed.</dd></dl></section></div></main></body></html> |