| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, miniz_oxide"><title>miniz_oxide - 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" 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="../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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../miniz_oxide/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../miniz_oxide/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate miniz_oxide</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.7.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">miniz_oxide</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></h1><span class="out-of-band"><a class="srclink" href="../src/miniz_oxide/lib.rs.html#1-209">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-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 href="#usage">Usage</a></h2><h3 id="simple-compressiondecompression"><a href="#simple-compressiondecompression">Simple compression/decompression:</a></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="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="deflate/index.html" title="miniz_oxide::deflate mod">deflate</a></div><div class="item-right docblock-short">This module contains functionality for compression.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="inflate/index.html" title="miniz_oxide::inflate mod">inflate</a></div><div class="item-right docblock-short">This module contains functionality for decompression.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamResult.html" title="miniz_oxide::StreamResult struct">StreamResult</a></div><div class="item-right docblock-short">A structure containing the result of a call to the inflate or deflate streaming functions.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DataFormat.html" title="miniz_oxide::DataFormat enum">DataFormat</a></div><div class="item-right docblock-short">How compressed data is wrapped.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MZError.html" title="miniz_oxide::MZError enum">MZError</a></div><div class="item-right docblock-short">A list of miniz failed status codes.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MZFlush.html" title="miniz_oxide::MZFlush enum">MZFlush</a></div><div class="item-right docblock-short">A list of flush types.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MZStatus.html" title="miniz_oxide::MZStatus enum">MZStatus</a></div><div class="item-right docblock-short">A list of miniz successful status codes.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.MZResult.html" title="miniz_oxide::MZResult type">MZResult</a></div><div class="item-right docblock-short"><code>Result</code> alias for all miniz status codes both successful and failed.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="miniz_oxide" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
