mirror of
https://github.com/edg-l/edlang.git
synced 2024-10-18 23:08:23 +00:00
42 lines
7.9 KiB
HTML
42 lines
7.9 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="Main decompression function. Keeps decompressing data from `in_buf` until the `in_buf` is empty, `out` is full, the end of the deflate stream is hit, or there is an error in the deflate stream."><title>decompress in miniz_oxide::inflate::core - 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::core</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">core</a>::<wbr><a class="fn" href="#">decompress</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/core.rs.html#1156-1802">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn decompress(
|
||
r: &mut <a class="struct" href="struct.DecompressorOxide.html" title="struct miniz_oxide::inflate::core::DecompressorOxide">DecompressorOxide</a>,
|
||
in_buf: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>],
|
||
out: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>],
|
||
out_pos: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>,
|
||
flags: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a>
|
||
) -> (<a class="enum" href="../enum.TINFLStatus.html" title="enum miniz_oxide::inflate::TINFLStatus">TINFLStatus</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Main decompression function. Keeps decompressing data from <code>in_buf</code> until the <code>in_buf</code> is
|
||
empty, <code>out</code> is full, the end of the deflate stream is hit, or there is an error in the
|
||
deflate stream.</p>
|
||
<h2 id="arguments"><a href="#arguments">Arguments</a></h2>
|
||
<p><code>r</code> is a <a href="struct.DecompressorOxide.html" title="struct miniz_oxide::inflate::core::DecompressorOxide"><code>DecompressorOxide</code></a> struct with the state of this stream.</p>
|
||
<p><code>in_buf</code> is a reference to the compressed data that is to be decompressed. The decompressor will
|
||
start at the first byte of this buffer.</p>
|
||
<p><code>out</code> is a reference to the buffer that will store the decompressed data, and that
|
||
stores previously decompressed data if any.</p>
|
||
<ul>
|
||
<li>The offset given by <code>out_pos</code> indicates where in the output buffer slice writing should start.</li>
|
||
<li>If <a href="inflate_flags/constant.TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF.html" title="constant miniz_oxide::inflate::core::inflate_flags::TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF"><code>TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF</code></a> is not set, the output buffer is used in a
|
||
wrapping manner, and it’s size is required to be a power of 2.</li>
|
||
<li>The decompression function normally needs access to 32KiB of the previously decompressed data
|
||
(or to the beginning of the decompressed data if less than 32KiB has been decompressed.)
|
||
<ul>
|
||
<li>If this data is not available, decompression may fail.</li>
|
||
<li>Some deflate compressors allow specifying a window size which limits match distances to
|
||
less than this, or alternatively an RLE mode where matches will only refer to the previous byte
|
||
and thus allows a smaller output buffer. The window size can be specified in the zlib
|
||
header structure, however, the header data should not be relied on to be correct.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p><code>flags</code> indicates settings and status to the decompression function.</p>
|
||
<ul>
|
||
<li>The <a href="inflate_flags/constant.TINFL_FLAG_HAS_MORE_INPUT.html" title="constant miniz_oxide::inflate::core::inflate_flags::TINFL_FLAG_HAS_MORE_INPUT"><code>TINFL_FLAG_HAS_MORE_INPUT</code></a> has to be specified if more compressed data is to be provided
|
||
in a subsequent call to this function.</li>
|
||
<li>See the the <a href="inflate_flags/index.html" title="mod miniz_oxide::inflate::core::inflate_flags"><code>inflate_flags</code></a> module for details on other flags.</li>
|
||
</ul>
|
||
<h2 id="returns"><a href="#returns">Returns</a></h2>
|
||
<p>Returns a tuple containing the status of the compressor, the number of input bytes read, and the
|
||
number of bytes output to <code>out</code>.</p>
|
||
<p>This function shouldn’t panic pending any bugs.</p>
|
||
</div></details></section></div></main></body></html> |