mirror of
https://github.com/edg-l/edlang.git
synced 2024-10-18 23:08:23 +00:00
24 lines
7.4 KiB
HTML
24 lines
7.4 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../miniz_oxide/index.html">miniz_oxide</a><span class="version">0.7.2</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In miniz_oxide::inflate::stream</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../miniz_oxide/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/miniz_oxide/inflate/stream.rs.html#185-291">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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.76.0/core/primitive.u8.html">u8</a>],
|
||
output: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/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 href="#flush"><code>flush</code></a></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 href="#errors">Errors</a></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> |