| <!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`]"><meta name="keywords" content="rust, rustlang, rust-lang, inflate"><title>inflate in miniz_oxide::inflate::stream - 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="sidebar-items.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 fn"><!--[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><div class="sidebar-elems"><h2><a href="index.html">In miniz_oxide::inflate::stream</a></h2></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">Function <a href="../../index.html">miniz_oxide</a>::<wbr><a href="../index.html">inflate</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="fn" href="#">inflate</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/inflate/stream.rs.html#185-286">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust fn"><code>pub fn inflate(<br> state: &mut <a class="struct" href="struct.InflateState.html" title="struct miniz_oxide::inflate::stream::InflateState">InflateState</a>,<br> input: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>],<br> output: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>],<br> flush: <a class="enum" href="../../enum.MZFlush.html" title="enum miniz_oxide::MZFlush">MZFlush</a><br>) -> <a class="struct" href="../../struct.StreamResult.html" title="struct miniz_oxide::StreamResult">StreamResult</a></code></pre></div><details class="rustdoc-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="InflateState"><code>InflateState</code></a></p> |
| <h2 id="flush"><a href="#flush"><code>flush</code></a></h2> |
| <p>Generally, the various <a href="../../enum.MZFlush.html" title="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="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="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="MZFlush::None"><code>MZFlush::None</code></a>.</p> |
| <h2 id="errors"><a href="#errors">Errors</a></h2> |
| <p>Returns <a href="../../enum.MZError.html#variant.Buf" title="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="MZFlush::Finish"><code>MZFlush::Finish</code></a> and input wasn’t all |
| consumed.</p> |
| <p>Returns <a href="../../enum.MZError.html#variant.Data" title="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="TINFLStatus"><code>TINFLStatus</code></a>; probably indicates corrupted data.</p> |
| <p>Returns <a href="../../enum.MZError.html#variant.Stream" title="MZError::Stream"><code>MZError::Stream</code></a> when called with <a href="../../enum.MZFlush.html#variant.Full" title="MZFlush::Full"><code>MZFlush::Full</code></a> (meaningless on |
| decompression), or when called without <a href="../../enum.MZFlush.html#variant.Finish" title="MZFlush::Finish"><code>MZFlush::Finish</code></a> after an earlier call with |
| <a href="../../enum.MZFlush.html#variant.Finish" title="MZFlush::Finish"><code>MZFlush::Finish</code></a> has been made.</p> |
| </div></details></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> |
