23 lines
6.6 KiB
HTML
23 lines
6.6 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="Try to decompress from `input` to `output` with the given `InflateState`"><title>inflate in miniz_oxide::inflate::stream - 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="sidebar-items.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 fn"><!--[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="#">inflate</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"><section id="rustdoc-toc"><h2 class="location"><a href="#">inflate</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#flush" title="`flush`"><code>flush</code></a></li><li><a href="#errors" title="Errors">Errors</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In miniz_<wbr>oxide::<wbr>inflate::<wbr>stream</a></h2></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"><div class="rustdoc-breadcrumbs"><a href="../../index.html">miniz_oxide</a>::<wbr><a href="../index.html">inflate</a>::<wbr><a href="index.html">stream</a></div><h1>Function <span class="fn">inflate</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/inflate/stream.rs.html#186-295">Source</a> </span></div><pre class="rust item-decl"><code>pub fn inflate(
|
||
state: &mut <a class="struct" href="struct.InflateState.html" title="struct miniz_oxide::inflate::stream::InflateState">InflateState</a>,
|
||
input: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
output: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
flush: <a class="enum" href="../../enum.MZFlush.html" title="enum miniz_oxide::MZFlush">MZFlush</a>,
|
||
) -> <a class="struct" href="../../struct.StreamResult.html" title="struct miniz_oxide::StreamResult">StreamResult</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Try to decompress from <code>input</code> to <code>output</code> with the given <a href="struct.InflateState.html" title="struct miniz_oxide::inflate::stream::InflateState"><code>InflateState</code></a></p>
|
||
<h2 id="flush"><a class="doc-anchor" href="#flush">§</a><code>flush</code></h2>
|
||
<p>Generally, the various <a href="../../enum.MZFlush.html" title="enum miniz_oxide::MZFlush"><code>MZFlush</code></a> flags have meaning only on the compression side. They can be
|
||
supplied here, but the only one that has any semantic meaning is <a href="../../enum.MZFlush.html#variant.Finish" title="variant miniz_oxide::MZFlush::Finish"><code>MZFlush::Finish</code></a>, which is a
|
||
signal that the stream is expected to finish, and failing to do so is an error. It isn’t
|
||
necessary to specify it when the stream ends; you’ll still get returned a
|
||
<a href="../../enum.MZStatus.html#variant.StreamEnd" title="variant miniz_oxide::MZStatus::StreamEnd"><code>MZStatus::StreamEnd</code></a> anyway. Other values either have no effect or cause errors. It’s
|
||
likely that you’ll almost always just want to use <a href="../../enum.MZFlush.html#variant.None" title="variant miniz_oxide::MZFlush::None"><code>MZFlush::None</code></a>.</p>
|
||
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2>
|
||
<p>Returns <a href="../../enum.MZError.html#variant.Buf" title="variant miniz_oxide::MZError::Buf"><code>MZError::Buf</code></a> if the size of the <code>output</code> slice is empty or no progress was made due
|
||
to lack of expected input data, or if called with <a href="../../enum.MZFlush.html#variant.Finish" title="variant miniz_oxide::MZFlush::Finish"><code>MZFlush::Finish</code></a> and input wasn’t all
|
||
consumed.</p>
|
||
<p>Returns <a href="../../enum.MZError.html#variant.Data" title="variant miniz_oxide::MZError::Data"><code>MZError::Data</code></a> if this or a a previous call failed with an error return from
|
||
<a href="../enum.TINFLStatus.html" title="enum miniz_oxide::inflate::TINFLStatus"><code>TINFLStatus</code></a>; probably indicates corrupted data.</p>
|
||
<p>Returns <a href="../../enum.MZError.html#variant.Stream" title="variant miniz_oxide::MZError::Stream"><code>MZError::Stream</code></a> when called with <a href="../../enum.MZFlush.html#variant.Full" title="variant miniz_oxide::MZFlush::Full"><code>MZFlush::Full</code></a> (meaningless on
|
||
decompression), or when called without <a href="../../enum.MZFlush.html#variant.Finish" title="variant miniz_oxide::MZFlush::Finish"><code>MZFlush::Finish</code></a> after an earlier call with
|
||
<a href="../../enum.MZFlush.html#variant.Finish" title="variant miniz_oxide::MZFlush::Finish"><code>MZFlush::Finish</code></a> has been made.</p>
|
||
</div></details></section></div></main></body></html> |