| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/miniz_oxide-0.7.1/src/deflate/stream.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stream.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../miniz_oxide/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Extra streaming compression functionality. |
| //! |
| //! As of now this is mainly intended for use to build a higher-level wrapper. |
| //! |
| //! There is no DeflateState as the needed state is contained in the compressor struct itself. |
| |
| </span><span class="kw">use </span><span class="kw">crate</span>::deflate::core::{compress, CompressorOxide, TDEFLFlush, TDEFLStatus}; |
| <span class="kw">use crate</span>::{MZError, MZFlush, MZStatus, StreamResult}; |
| |
| <span class="doccomment">/// Try to compress from input to output with the given [`CompressorOxide`]. |
| /// |
| /// # Errors |
| /// |
| /// Returns [`MZError::Buf`] If the size of the `output` slice is empty or no progress was made due |
| /// to lack of expected input data, or if called without [`MZFlush::Finish`] after the compression |
| /// was already finished. |
| /// |
| /// Returns [`MZError::Param`] if the compressor parameters are set wrong. |
| /// |
| /// Returns [`MZError::Stream`] when lower-level decompressor returns a |
| /// [`TDEFLStatus::PutBufFailed`]; may not actually be possible. |
| </span><span class="kw">pub fn </span>deflate( |
| compressor: <span class="kw-2">&mut </span>CompressorOxide, |
| input: <span class="kw-2">&</span>[u8], |
| output: <span class="kw-2">&mut </span>[u8], |
| flush: MZFlush, |
| ) -> StreamResult { |
| <span class="kw">if </span>output.is_empty() { |
| <span class="kw">return </span>StreamResult::error(MZError::Buf); |
| } |
| |
| <span class="kw">if </span>compressor.prev_return_status() == TDEFLStatus::Done { |
| <span class="kw">return if </span>flush == MZFlush::Finish { |
| StreamResult { |
| bytes_written: <span class="number">0</span>, |
| bytes_consumed: <span class="number">0</span>, |
| status: <span class="prelude-val">Ok</span>(MZStatus::StreamEnd), |
| } |
| } <span class="kw">else </span>{ |
| StreamResult::error(MZError::Buf) |
| }; |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes_written = <span class="number">0</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes_consumed = <span class="number">0</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>next_in = input; |
| <span class="kw">let </span><span class="kw-2">mut </span>next_out = output; |
| |
| <span class="kw">let </span>status = <span class="kw">loop </span>{ |
| <span class="kw">let </span>in_bytes; |
| <span class="kw">let </span>out_bytes; |
| <span class="kw">let </span>defl_status = { |
| <span class="kw">let </span>res = compress(compressor, next_in, next_out, TDEFLFlush::from(flush)); |
| in_bytes = res.<span class="number">1</span>; |
| out_bytes = res.<span class="number">2</span>; |
| res.<span class="number">0 |
| </span>}; |
| |
| next_in = <span class="kw-2">&</span>next_in[in_bytes..]; |
| next_out = <span class="kw-2">&mut </span>next_out[out_bytes..]; |
| bytes_consumed += in_bytes; |
| bytes_written += out_bytes; |
| |
| <span class="comment">// Check if we are done, or compression failed. |
| </span><span class="kw">match </span>defl_status { |
| TDEFLStatus::BadParam => <span class="kw">break </span><span class="prelude-val">Err</span>(MZError::Param), |
| <span class="comment">// Don't think this can happen as we're not using a custom callback. |
| </span>TDEFLStatus::PutBufFailed => <span class="kw">break </span><span class="prelude-val">Err</span>(MZError::Stream), |
| TDEFLStatus::Done => <span class="kw">break </span><span class="prelude-val">Ok</span>(MZStatus::StreamEnd), |
| <span class="kw">_ </span>=> (), |
| }; |
| |
| <span class="comment">// All the output space was used, so wait for more. |
| </span><span class="kw">if </span>next_out.is_empty() { |
| <span class="kw">break </span><span class="prelude-val">Ok</span>(MZStatus::Ok); |
| } |
| |
| <span class="kw">if </span>next_in.is_empty() && (flush != MZFlush::Finish) { |
| <span class="kw">let </span>total_changed = bytes_written > <span class="number">0 </span>|| bytes_consumed > <span class="number">0</span>; |
| |
| <span class="kw">break if </span>(flush != MZFlush::None) || total_changed { |
| <span class="comment">// We wrote or consumed something, and/or did a flush (sync/partial etc.). |
| </span><span class="prelude-val">Ok</span>(MZStatus::Ok) |
| } <span class="kw">else </span>{ |
| <span class="comment">// No more input data, not flushing, and nothing was consumed or written, |
| // so couldn't make any progress. |
| </span><span class="prelude-val">Err</span>(MZError::Buf) |
| }; |
| } |
| }; |
| StreamResult { |
| bytes_consumed, |
| bytes_written, |
| status, |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| <span class="kw">use </span><span class="kw">super</span>::deflate; |
| <span class="kw">use </span><span class="kw">crate</span>::deflate::CompressorOxide; |
| <span class="kw">use </span><span class="kw">crate</span>::inflate::decompress_to_vec_zlib; |
| <span class="kw">use crate</span>::{MZFlush, MZStatus}; |
| <span class="kw">use </span>alloc::boxed::Box; |
| <span class="kw">use </span>alloc::vec; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_state() { |
| <span class="kw">let </span>data = <span class="string">b"Hello zlib!"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>compressed = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">50</span>]; |
| <span class="kw">let </span><span class="kw-2">mut </span>compressor = Box::<CompressorOxide>::default(); |
| <span class="kw">let </span>res = deflate(<span class="kw-2">&mut </span>compressor, data, <span class="kw-2">&mut </span>compressed, MZFlush::Finish); |
| <span class="kw">let </span>status = res.status.expect(<span class="string">"Failed to compress!"</span>); |
| <span class="kw">let </span>decomp = |
| decompress_to_vec_zlib(<span class="kw-2">&</span>compressed).expect(<span class="string">"Failed to decompress compressed data"</span>); |
| <span class="macro">assert_eq!</span>(status, MZStatus::StreamEnd); |
| <span class="macro">assert_eq!</span>(decomp[..], data[..]); |
| <span class="macro">assert_eq!</span>(res.bytes_consumed, data.len()); |
| } |
| } |
| </code></pre></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> |
