Adding large folders

This commit is contained in:
2026-02-26 12:00:21 -05:00
parent 5400d82acd
commit 49701c85ad
47332 changed files with 1942573 additions and 0 deletions

View File

@@ -0,0 +1,112 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/brotli/decoder.rs`."><title>decoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/brotli/</div>decoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span><span class="kw">crate</span>::DecodeV2;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>brotli::{enc::StandardAlloc, BrotliDecompressStream, BrotliResult};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::{fmt, io};
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">type </span>BrotliState = brotli::BrotliState&lt;StandardAlloc, StandardAlloc, StandardAlloc&gt;;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub struct </span>BrotliDecoder {
<a href=#9 id=9 data-nosnippet>9</a> <span class="comment">// `BrotliState` is very large (over 2kb) which is why we're boxing it.
<a href=#10 id=10 data-nosnippet>10</a> </span>state: Box&lt;BrotliState&gt;,
<a href=#11 id=11 data-nosnippet>11</a>}
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">impl </span>Default <span class="kw">for </span>BrotliDecoder {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#15 id=15 data-nosnippet>15</a> <span class="self">Self </span>{
<a href=#16 id=16 data-nosnippet>16</a> state: Box::new(<span class="self">Self</span>::new_brotli_state()),
<a href=#17 id=17 data-nosnippet>17</a> }
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a>}
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">impl </span>BrotliDecoder {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">fn </span>new_brotli_state() -&gt; BrotliState {
<a href=#23 id=23 data-nosnippet>23</a> BrotliState::new(
<a href=#24 id=24 data-nosnippet>24</a> StandardAlloc::default(),
<a href=#25 id=25 data-nosnippet>25</a> StandardAlloc::default(),
<a href=#26 id=26 data-nosnippet>26</a> StandardAlloc::default(),
<a href=#27 id=27 data-nosnippet>27</a> )
<a href=#28 id=28 data-nosnippet>28</a> }
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<a href=#31 id=31 data-nosnippet>31</a> <span class="self">Self</span>::default()
<a href=#32 id=32 data-nosnippet>32</a> }
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">fn </span>decode(
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#36 id=36 data-nosnippet>36</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#37 id=37 data-nosnippet>37</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#38 id=38 data-nosnippet>38</a> ) -&gt; io::Result&lt;BrotliResult&gt; {
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>in_buf = input.unwritten();
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>out_buf = output.initialize_unwritten();
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">let </span><span class="kw-2">mut </span>input_len = <span class="number">0</span>;
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span><span class="kw-2">mut </span>output_len = <span class="number">0</span>;
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span>status = <span class="kw">match </span>BrotliDecompressStream(
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw-2">&amp;mut </span>in_buf.len(),
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw-2">&amp;mut </span>input_len,
<a href=#48 id=48 data-nosnippet>48</a> in_buf,
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw-2">&amp;mut </span>out_buf.len(),
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw-2">&amp;mut </span>output_len,
<a href=#51 id=51 data-nosnippet>51</a> out_buf,
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw-2">&amp;mut </span><span class="number">0</span>,
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>.state,
<a href=#54 id=54 data-nosnippet>54</a> ) {
<a href=#55 id=55 data-nosnippet>55</a> BrotliResult::ResultFailure =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::other(<span class="string">"brotli error"</span>)),
<a href=#56 id=56 data-nosnippet>56</a> status =&gt; status,
<a href=#57 id=57 data-nosnippet>57</a> };
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> input.advance(input_len);
<a href=#60 id=60 data-nosnippet>60</a> output.advance(output_len);
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="prelude-val">Ok</span>(status)
<a href=#63 id=63 data-nosnippet>63</a> }
<a href=#64 id=64 data-nosnippet>64</a>}
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a><span class="kw">impl </span>DecodeV2 <span class="kw">for </span>BrotliDecoder {
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw-2">*</span><span class="self">self</span>.state = <span class="self">Self</span>::new_brotli_state();
<a href=#69 id=69 data-nosnippet>69</a> <span class="prelude-val">Ok</span>(())
<a href=#70 id=70 data-nosnippet>70</a> }
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">fn </span>decode(
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#74 id=74 data-nosnippet>74</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#75 id=75 data-nosnippet>75</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#76 id=76 data-nosnippet>76</a> ) -&gt; io::Result&lt;bool&gt; {
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">match </span><span class="self">self</span>.decode(input, output)<span class="question-mark">? </span>{
<a href=#78 id=78 data-nosnippet>78</a> BrotliResult::ResultSuccess =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#79 id=79 data-nosnippet>79</a> BrotliResult::NeedsMoreOutput | BrotliResult::NeedsMoreInput =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<a href=#80 id=80 data-nosnippet>80</a> BrotliResult::ResultFailure =&gt; <span class="macro">unreachable!</span>(),
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">match </span><span class="self">self</span>.decode(<span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]), output)<span class="question-mark">? </span>{
<a href=#86 id=86 data-nosnippet>86</a> BrotliResult::ResultSuccess | BrotliResult::NeedsMoreInput =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#87 id=87 data-nosnippet>87</a> BrotliResult::NeedsMoreOutput =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<a href=#88 id=88 data-nosnippet>88</a> BrotliResult::ResultFailure =&gt; <span class="macro">unreachable!</span>(),
<a href=#89 id=89 data-nosnippet>89</a> }
<a href=#90 id=90 data-nosnippet>90</a> }
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">match </span><span class="self">self</span>.decode(<span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]), output)<span class="question-mark">? </span>{
<a href=#94 id=94 data-nosnippet>94</a> BrotliResult::ResultSuccess =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#95 id=95 data-nosnippet>95</a> BrotliResult::NeedsMoreOutput =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<a href=#96 id=96 data-nosnippet>96</a> BrotliResult::NeedsMoreInput =&gt; <span class="prelude-val">Err</span>(io::Error::new(
<a href=#97 id=97 data-nosnippet>97</a> io::ErrorKind::UnexpectedEof,
<a href=#98 id=98 data-nosnippet>98</a> <span class="string">"reached unexpected EOF"</span>,
<a href=#99 id=99 data-nosnippet>99</a> )),
<a href=#100 id=100 data-nosnippet>100</a> BrotliResult::ResultFailure =&gt; <span class="macro">unreachable!</span>(),
<a href=#101 id=101 data-nosnippet>101</a> }
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>}
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>BrotliDecoder {
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#107 id=107 data-nosnippet>107</a> f.debug_struct(<span class="string">"BrotliDecoder"</span>)
<a href=#108 id=108 data-nosnippet>108</a> .field(<span class="string">"decompress"</span>, <span class="kw-2">&amp;</span><span class="string">"&lt;no debug&gt;"</span>)
<a href=#109 id=109 data-nosnippet>109</a> .finish()
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,96 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/brotli/encoder.rs`."><title>encoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/brotli/</div>encoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{brotli::params::EncoderParams, EncodeV2};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>brotli::enc::{
<a href=#3 id=3 data-nosnippet>3</a> backward_references::BrotliEncoderParams,
<a href=#4 id=4 data-nosnippet>4</a> encode::{BrotliEncoderOperation, BrotliEncoderStateStruct},
<a href=#5 id=5 data-nosnippet>5</a> StandardAlloc,
<a href=#6 id=6 data-nosnippet>6</a>};
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>std::{fmt, io};
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">pub struct </span>BrotliEncoder {
<a href=#11 id=11 data-nosnippet>11</a> state: BrotliEncoderStateStruct&lt;StandardAlloc&gt;,
<a href=#12 id=12 data-nosnippet>12</a>}
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">impl </span>BrotliEncoder {
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">pub fn </span>new(params: EncoderParams) -&gt; <span class="self">Self </span>{
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">let </span>params = BrotliEncoderParams::from(params);
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span><span class="kw-2">mut </span>state = BrotliEncoderStateStruct::new(StandardAlloc::default());
<a href=#18 id=18 data-nosnippet>18</a> state.params = params;
<a href=#19 id=19 data-nosnippet>19</a> <span class="self">Self </span>{ state }
<a href=#20 id=20 data-nosnippet>20</a> }
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">fn </span>encode(
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#24 id=24 data-nosnippet>24</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#25 id=25 data-nosnippet>25</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#26 id=26 data-nosnippet>26</a> op: BrotliEncoderOperation,
<a href=#27 id=27 data-nosnippet>27</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>in_buf = input.unwritten();
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let </span>out_buf = output.initialize_unwritten();
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">let </span><span class="kw-2">mut </span>input_len = <span class="number">0</span>;
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">let </span><span class="kw-2">mut </span>output_len = <span class="number">0</span>;
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">if </span>!<span class="self">self</span>.state.compress_stream(
<a href=#35 id=35 data-nosnippet>35</a> op,
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw-2">&amp;mut </span>in_buf.len(),
<a href=#37 id=37 data-nosnippet>37</a> in_buf,
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw-2">&amp;mut </span>input_len,
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw-2">&amp;mut </span>out_buf.len(),
<a href=#40 id=40 data-nosnippet>40</a> out_buf,
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw-2">&amp;mut </span>output_len,
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw-2">&amp;mut </span><span class="prelude-val">None</span>,
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw-2">&amp;mut </span>|<span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span>, <span class="kw">_</span>| (),
<a href=#44 id=44 data-nosnippet>44</a> ) {
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::other(<span class="string">"brotli error"</span>));
<a href=#46 id=46 data-nosnippet>46</a> }
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a> input.advance(input_len);
<a href=#49 id=49 data-nosnippet>49</a> output.advance(output_len);
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="prelude-val">Ok</span>(())
<a href=#52 id=52 data-nosnippet>52</a> }
<a href=#53 id=53 data-nosnippet>53</a>}
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a><span class="kw">impl </span>EncodeV2 <span class="kw">for </span>BrotliEncoder {
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">fn </span>encode(
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#58 id=58 data-nosnippet>58</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#59 id=59 data-nosnippet>59</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#60 id=60 data-nosnippet>60</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#61 id=61 data-nosnippet>61</a> <span class="self">self</span>.encode(
<a href=#62 id=62 data-nosnippet>62</a> input,
<a href=#63 id=63 data-nosnippet>63</a> output,
<a href=#64 id=64 data-nosnippet>64</a> BrotliEncoderOperation::BROTLI_OPERATION_PROCESS,
<a href=#65 id=65 data-nosnippet>65</a> )
<a href=#66 id=66 data-nosnippet>66</a> }
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">self</span>.encode(
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#71 id=71 data-nosnippet>71</a> output,
<a href=#72 id=72 data-nosnippet>72</a> BrotliEncoderOperation::BROTLI_OPERATION_FLUSH,
<a href=#73 id=73 data-nosnippet>73</a> )<span class="question-mark">?</span>;
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a> <span class="prelude-val">Ok</span>(!<span class="self">self</span>.state.has_more_output())
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#79 id=79 data-nosnippet>79</a> <span class="self">self</span>.encode(
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#81 id=81 data-nosnippet>81</a> output,
<a href=#82 id=82 data-nosnippet>82</a> BrotliEncoderOperation::BROTLI_OPERATION_FINISH,
<a href=#83 id=83 data-nosnippet>83</a> )<span class="question-mark">?</span>;
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="prelude-val">Ok</span>(<span class="self">self</span>.state.is_finished())
<a href=#86 id=86 data-nosnippet>86</a> }
<a href=#87 id=87 data-nosnippet>87</a>}
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>BrotliEncoder {
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#91 id=91 data-nosnippet>91</a> f.debug_struct(<span class="string">"BrotliEncoder"</span>)
<a href=#92 id=92 data-nosnippet>92</a> .field(<span class="string">"compress"</span>, <span class="kw-2">&amp;</span><span class="string">"&lt;no debug&gt;"</span>)
<a href=#93 id=93 data-nosnippet>93</a> .finish()
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,6 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/brotli/mod.rs`."><title>mod.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/brotli/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-1"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>decoder;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">mod </span>encoder;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">pub mod </span>params;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub use </span><span class="self">self</span>::{decoder::BrotliDecoder, encoder::BrotliEncoder};
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,93 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/brotli/params.rs`."><title>params.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/brotli/</div>params.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! This module contains Brotli-specific types for async-compression.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>brotli::enc::backward_references::{BrotliEncoderMode, BrotliEncoderParams};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>compression_core::Level;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="doccomment">/// Brotli compression parameters builder. This is a stable wrapper around Brotli's own encoder
<a href=#7 id=7 data-nosnippet>7</a>/// params type, to abstract over different versions of the Brotli library.
<a href=#8 id=8 data-nosnippet>8</a>///
<a href=#9 id=9 data-nosnippet>9</a>/// See the [Brotli documentation](https://www.brotli.org/encode.html#a9a8) for more information on
<a href=#10 id=10 data-nosnippet>10</a>/// these parameters.
<a href=#11 id=11 data-nosnippet>11</a>///
<a href=#12 id=12 data-nosnippet>12</a>/// # Examples
<a href=#13 id=13 data-nosnippet>13</a>///
<a href=#14 id=14 data-nosnippet>14</a>/// ```
<a href=#15 id=15 data-nosnippet>15</a>/// use compression_codecs::brotli;
<a href=#16 id=16 data-nosnippet>16</a>///
<a href=#17 id=17 data-nosnippet>17</a>/// let params = brotli::params::EncoderParams::default()
<a href=#18 id=18 data-nosnippet>18</a>/// .window_size(12)
<a href=#19 id=19 data-nosnippet>19</a>/// .text_mode();
<a href=#20 id=20 data-nosnippet>20</a>/// ```
<a href=#21 id=21 data-nosnippet>21</a></span><span class="attr">#[derive(Debug, Clone, Default)]
<a href=#22 id=22 data-nosnippet>22</a></span><span class="kw">pub struct </span>EncoderParams {
<a href=#23 id=23 data-nosnippet>23</a> inner: BrotliEncoderParams,
<a href=#24 id=24 data-nosnippet>24</a>}
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">impl </span>From&lt;EncoderParams&gt; <span class="kw">for </span>BrotliEncoderParams {
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">fn </span>from(value: EncoderParams) -&gt; <span class="self">Self </span>{
<a href=#28 id=28 data-nosnippet>28</a> value.inner
<a href=#29 id=29 data-nosnippet>29</a> }
<a href=#30 id=30 data-nosnippet>30</a>}
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">impl </span>EncoderParams {
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">pub fn </span>quality(<span class="kw-2">mut </span><span class="self">self</span>, level: Level) -&gt; <span class="self">Self </span>{
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>quality = <span class="kw">match </span>level {
<a href=#35 id=35 data-nosnippet>35</a> Level::Fastest =&gt; <span class="prelude-val">Some</span>(<span class="number">0</span>),
<a href=#36 id=36 data-nosnippet>36</a> Level::Best =&gt; <span class="prelude-val">Some</span>(<span class="number">11</span>),
<a href=#37 id=37 data-nosnippet>37</a> Level::Precise(quality) =&gt; <span class="prelude-val">Some</span>(quality.clamp(<span class="number">0</span>, <span class="number">11</span>)),
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
<a href=#39 id=39 data-nosnippet>39</a> };
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">match </span>quality {
<a href=#41 id=41 data-nosnippet>41</a> <span class="prelude-val">Some</span>(quality) =&gt; <span class="self">self</span>.inner.quality = quality,
<a href=#42 id=42 data-nosnippet>42</a> <span class="prelude-val">None </span>=&gt; {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span>default_params = BrotliEncoderParams::default();
<a href=#44 id=44 data-nosnippet>44</a> <span class="self">self</span>.inner.quality = default_params.quality;
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a> }
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a> <span class="self">self
<a href=#49 id=49 data-nosnippet>49</a> </span>}
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="doccomment">/// Sets window size in bytes (as a power of two).
<a href=#52 id=52 data-nosnippet>52</a> ///
<a href=#53 id=53 data-nosnippet>53</a> /// Used as Brotli's `lgwin` parameter.
<a href=#54 id=54 data-nosnippet>54</a> ///
<a href=#55 id=55 data-nosnippet>55</a> /// `window_size` is clamped to `0 &lt;= window_size &lt;= 24`.
<a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">pub fn </span>window_size(<span class="kw-2">mut </span><span class="self">self</span>, window_size: i32) -&gt; <span class="self">Self </span>{
<a href=#57 id=57 data-nosnippet>57</a> <span class="self">self</span>.inner.lgwin = window_size.clamp(<span class="number">0</span>, <span class="number">24</span>);
<a href=#58 id=58 data-nosnippet>58</a> <span class="self">self
<a href=#59 id=59 data-nosnippet>59</a> </span>}
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="doccomment">/// Sets input block size in bytes (as a power of two).
<a href=#62 id=62 data-nosnippet>62</a> ///
<a href=#63 id=63 data-nosnippet>63</a> /// Used as Brotli's `lgblock` parameter.
<a href=#64 id=64 data-nosnippet>64</a> ///
<a href=#65 id=65 data-nosnippet>65</a> /// `block_size` is clamped to `16 &lt;= block_size &lt;= 24`.
<a href=#66 id=66 data-nosnippet>66</a> </span><span class="kw">pub fn </span>block_size(<span class="kw-2">mut </span><span class="self">self</span>, block_size: i32) -&gt; <span class="self">Self </span>{
<a href=#67 id=67 data-nosnippet>67</a> <span class="self">self</span>.inner.lgblock = block_size.clamp(<span class="number">16</span>, <span class="number">24</span>);
<a href=#68 id=68 data-nosnippet>68</a> <span class="self">self
<a href=#69 id=69 data-nosnippet>69</a> </span>}
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="doccomment">/// Sets hint for size of data to be compressed.
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">pub fn </span>size_hint(<span class="kw-2">mut </span><span class="self">self</span>, size_hint: usize) -&gt; <span class="self">Self </span>{
<a href=#73 id=73 data-nosnippet>73</a> <span class="self">self</span>.inner.size_hint = size_hint;
<a href=#74 id=74 data-nosnippet>74</a> <span class="self">self
<a href=#75 id=75 data-nosnippet>75</a> </span>}
<a href=#76 id=76 data-nosnippet>76</a>
<a href=#77 id=77 data-nosnippet>77</a> <span class="doccomment">/// Sets encoder to text mode.
<a href=#78 id=78 data-nosnippet>78</a> ///
<a href=#79 id=79 data-nosnippet>79</a> /// If input data is known to be UTF-8 text, this allows the compressor to make assumptions and
<a href=#80 id=80 data-nosnippet>80</a> /// optimizations.
<a href=#81 id=81 data-nosnippet>81</a> ///
<a href=#82 id=82 data-nosnippet>82</a> /// Used as Brotli's `mode` parameter.
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">pub fn </span>text_mode(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<a href=#84 id=84 data-nosnippet>84</a> <span class="self">self</span>.inner.mode = BrotliEncoderMode::BROTLI_MODE_TEXT;
<a href=#85 id=85 data-nosnippet>85</a> <span class="self">self
<a href=#86 id=86 data-nosnippet>86</a> </span>}
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">pub fn </span>mode(<span class="kw-2">mut </span><span class="self">self</span>, mode: BrotliEncoderMode) -&gt; <span class="self">Self </span>{
<a href=#89 id=89 data-nosnippet>89</a> <span class="self">self</span>.inner.mode = mode;
<a href=#90 id=90 data-nosnippet>90</a> <span class="self">self
<a href=#91 id=91 data-nosnippet>91</a> </span>}
<a href=#92 id=92 data-nosnippet>92</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,96 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/flate/decoder.rs`."><title>decoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/flate/</div>decoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span><span class="kw">crate</span>::DecodeV2;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>flate2::{Decompress, FlushDecompress, Status};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::io;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="attr">#[derive(Debug)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub struct </span>FlateDecoder {
<a href=#8 id=8 data-nosnippet>8</a> zlib_header: bool,
<a href=#9 id=9 data-nosnippet>9</a> decompress: Decompress,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">impl </span>FlateDecoder {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(zlib_header: bool) -&gt; <span class="self">Self </span>{
<a href=#14 id=14 data-nosnippet>14</a> <span class="self">Self </span>{
<a href=#15 id=15 data-nosnippet>15</a> zlib_header,
<a href=#16 id=16 data-nosnippet>16</a> decompress: Decompress::new(zlib_header),
<a href=#17 id=17 data-nosnippet>17</a> }
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">fn </span>decode(
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#22 id=22 data-nosnippet>22</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#23 id=23 data-nosnippet>23</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#24 id=24 data-nosnippet>24</a> flush: FlushDecompress,
<a href=#25 id=25 data-nosnippet>25</a> ) -&gt; io::Result&lt;Status&gt; {
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">let </span>prior_in = <span class="self">self</span>.decompress.total_in();
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>prior_out = <span class="self">self</span>.decompress.total_out();
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let </span>status = <span class="self">self
<a href=#30 id=30 data-nosnippet>30</a> </span>.decompress
<a href=#31 id=31 data-nosnippet>31</a> <span class="comment">// Safety: We **trust** flate2 to not write uninitialized bytes into buffer
<a href=#32 id=32 data-nosnippet>32</a> </span>.decompress_uninit(input.unwritten(), <span class="kw">unsafe </span>{ output.unwritten_mut() }, flush)<span class="question-mark">?</span>;
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> input.advance((<span class="self">self</span>.decompress.total_in() - prior_in) <span class="kw">as </span>usize);
<a href=#35 id=35 data-nosnippet>35</a> <span class="comment">// Safety: We **trust** flate2 to write bytes into buffer properly
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="kw">unsafe </span>{
<a href=#37 id=37 data-nosnippet>37</a> output.assume_init_and_advance((<span class="self">self</span>.decompress.total_out() - prior_out) <span class="kw">as </span>usize)
<a href=#38 id=38 data-nosnippet>38</a> };
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="prelude-val">Ok</span>(status)
<a href=#41 id=41 data-nosnippet>41</a> }
<a href=#42 id=42 data-nosnippet>42</a>}
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a><span class="kw">impl </span>DecodeV2 <span class="kw">for </span>FlateDecoder {
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#46 id=46 data-nosnippet>46</a> <span class="self">self</span>.decompress.reset(<span class="self">self</span>.zlib_header);
<a href=#47 id=47 data-nosnippet>47</a> <span class="prelude-val">Ok</span>(())
<a href=#48 id=48 data-nosnippet>48</a> }
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">fn </span>decode(
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#52 id=52 data-nosnippet>52</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#53 id=53 data-nosnippet>53</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#54 id=54 data-nosnippet>54</a> ) -&gt; io::Result&lt;bool&gt; {
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">match </span><span class="self">self</span>.decode(input, output, FlushDecompress::None)<span class="question-mark">? </span>{
<a href=#56 id=56 data-nosnippet>56</a> Status::Ok =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<a href=#57 id=57 data-nosnippet>57</a> Status::StreamEnd =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#58 id=58 data-nosnippet>58</a> Status::BufError =&gt; <span class="prelude-val">Err</span>(io::Error::other(<span class="string">"unexpected BufError"</span>)),
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#63 id=63 data-nosnippet>63</a> <span class="self">self</span>.decode(
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#65 id=65 data-nosnippet>65</a> output,
<a href=#66 id=66 data-nosnippet>66</a> FlushDecompress::Sync,
<a href=#67 id=67 data-nosnippet>67</a> )<span class="question-mark">?</span>;
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">loop </span>{
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw">let </span>old_len = output.written_len();
<a href=#71 id=71 data-nosnippet>71</a> <span class="self">self</span>.decode(
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#73 id=73 data-nosnippet>73</a> output,
<a href=#74 id=74 data-nosnippet>74</a> FlushDecompress::None,
<a href=#75 id=75 data-nosnippet>75</a> )<span class="question-mark">?</span>;
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">if </span>output.written_len() == old_len {
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">break</span>;
<a href=#78 id=78 data-nosnippet>78</a> }
<a href=#79 id=79 data-nosnippet>79</a> }
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a> <span class="prelude-val">Ok</span>(!output.has_no_spare_space())
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">match </span><span class="self">self</span>.decode(
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#87 id=87 data-nosnippet>87</a> output,
<a href=#88 id=88 data-nosnippet>88</a> FlushDecompress::Finish,
<a href=#89 id=89 data-nosnippet>89</a> )<span class="question-mark">? </span>{
<a href=#90 id=90 data-nosnippet>90</a> Status::Ok =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<a href=#91 id=91 data-nosnippet>91</a> Status::StreamEnd =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#92 id=92 data-nosnippet>92</a> Status::BufError =&gt; <span class="prelude-val">Err</span>(io::Error::other(<span class="string">"unexpected BufError"</span>)),
<a href=#93 id=93 data-nosnippet>93</a> }
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,104 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/flate/encoder.rs`."><title>encoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/flate/</div>encoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{flate::params::FlateEncoderParams, EncodeV2};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>flate2::{Compress, FlushCompress, Status};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::io;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="attr">#[derive(Debug)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub struct </span>FlateEncoder {
<a href=#8 id=8 data-nosnippet>8</a> compress: Compress,
<a href=#9 id=9 data-nosnippet>9</a> flushed: bool,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">impl </span>FlateEncoder {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">pub fn </span>new(level: FlateEncoderParams, zlib_header: bool) -&gt; <span class="self">Self </span>{
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">let </span>level = flate2::Compression::from(level);
<a href=#15 id=15 data-nosnippet>15</a> <span class="self">Self </span>{
<a href=#16 id=16 data-nosnippet>16</a> compress: Compress::new(level, zlib_header),
<a href=#17 id=17 data-nosnippet>17</a> flushed: <span class="bool-val">true</span>,
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a> }
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Compress {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw-2">&amp;</span><span class="self">self</span>.compress
<a href=#23 id=23 data-nosnippet>23</a> }
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">fn </span>encode(
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#27 id=27 data-nosnippet>27</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#28 id=28 data-nosnippet>28</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#29 id=29 data-nosnippet>29</a> flush: FlushCompress,
<a href=#30 id=30 data-nosnippet>30</a> ) -&gt; io::Result&lt;Status&gt; {
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">let </span>prior_in = <span class="self">self</span>.compress.total_in();
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">let </span>prior_out = <span class="self">self</span>.compress.total_out();
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>status = <span class="self">self
<a href=#35 id=35 data-nosnippet>35</a> </span>.compress
<a href=#36 id=36 data-nosnippet>36</a> <span class="comment">// Safety: We **trust** flate2 to not write uninitialized bytes into buffer
<a href=#37 id=37 data-nosnippet>37</a> </span>.compress_uninit(input.unwritten(), <span class="kw">unsafe </span>{ output.unwritten_mut() }, flush)<span class="question-mark">?</span>;
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> input.advance((<span class="self">self</span>.compress.total_in() - prior_in) <span class="kw">as </span>usize);
<a href=#40 id=40 data-nosnippet>40</a> <span class="comment">// Safety: We **trust** flate2 to write bytes properly into buffer
<a href=#41 id=41 data-nosnippet>41</a> </span><span class="kw">unsafe </span>{ output.assume_init_and_advance((<span class="self">self</span>.compress.total_out() - prior_out) <span class="kw">as </span>usize) };
<a href=#42 id=42 data-nosnippet>42</a>
<a href=#43 id=43 data-nosnippet>43</a> <span class="prelude-val">Ok</span>(status)
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>}
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a><span class="kw">impl </span>EncodeV2 <span class="kw">for </span>FlateEncoder {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">fn </span>encode(
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#50 id=50 data-nosnippet>50</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#51 id=51 data-nosnippet>51</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#52 id=52 data-nosnippet>52</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#53 id=53 data-nosnippet>53</a> <span class="self">self</span>.flushed = <span class="bool-val">false</span>;
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">match </span><span class="self">self</span>.encode(input, output, FlushCompress::None)<span class="question-mark">? </span>{
<a href=#55 id=55 data-nosnippet>55</a> Status::Ok =&gt; <span class="prelude-val">Ok</span>(()),
<a href=#56 id=56 data-nosnippet>56</a> Status::StreamEnd =&gt; <span class="macro">unreachable!</span>(),
<a href=#57 id=57 data-nosnippet>57</a> Status::BufError =&gt; <span class="prelude-val">Err</span>(io::Error::other(<span class="string">"unexpected BufError"</span>)),
<a href=#58 id=58 data-nosnippet>58</a> }
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#62 id=62 data-nosnippet>62</a> <span class="comment">// We need to keep track of whether we've already flushed otherwise we'll just keep writing
<a href=#63 id=63 data-nosnippet>63</a> // out sync blocks continuously and probably never complete flushing.
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">if </span><span class="self">self</span>.flushed {
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">true</span>);
<a href=#66 id=66 data-nosnippet>66</a> }
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> <span class="self">self</span>.encode(
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#70 id=70 data-nosnippet>70</a> output,
<a href=#71 id=71 data-nosnippet>71</a> FlushCompress::Sync,
<a href=#72 id=72 data-nosnippet>72</a> )<span class="question-mark">?</span>;
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">loop </span>{
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>old_len = output.written_len();
<a href=#76 id=76 data-nosnippet>76</a> <span class="self">self</span>.encode(
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#78 id=78 data-nosnippet>78</a> output,
<a href=#79 id=79 data-nosnippet>79</a> FlushCompress::None,
<a href=#80 id=80 data-nosnippet>80</a> )<span class="question-mark">?</span>;
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">if </span>output.written_len() == old_len {
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">break</span>;
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a> }
<a href=#85 id=85 data-nosnippet>85</a>
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">let </span>internal_flushed = !output.has_no_spare_space();
<a href=#87 id=87 data-nosnippet>87</a> <span class="self">self</span>.flushed = internal_flushed;
<a href=#88 id=88 data-nosnippet>88</a> <span class="prelude-val">Ok</span>(internal_flushed)
<a href=#89 id=89 data-nosnippet>89</a> }
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#92 id=92 data-nosnippet>92</a> <span class="self">self</span>.flushed = <span class="bool-val">false</span>;
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">match </span><span class="self">self</span>.encode(
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw-2">&amp;mut </span>PartialBuffer::new(<span class="kw-2">&amp;</span>[][..]),
<a href=#95 id=95 data-nosnippet>95</a> output,
<a href=#96 id=96 data-nosnippet>96</a> FlushCompress::Finish,
<a href=#97 id=97 data-nosnippet>97</a> )<span class="question-mark">? </span>{
<a href=#98 id=98 data-nosnippet>98</a> Status::Ok =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<a href=#99 id=99 data-nosnippet>99</a> Status::StreamEnd =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#100 id=100 data-nosnippet>100</a> Status::BufError =&gt; <span class="prelude-val">Err</span>(io::Error::other(<span class="string">"unexpected BufError"</span>)),
<a href=#101 id=101 data-nosnippet>101</a> }
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,6 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/flate/mod.rs`."><title>mod.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/flate/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-1"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>decoder;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">mod </span>encoder;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">pub mod </span>params;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub use </span><span class="self">self</span>::{decoder::FlateDecoder, encoder::FlateEncoder};
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,41 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/flate/params.rs`."><title>params.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/flate/</div>params.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::convert::TryInto;
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>compression_core::Level;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="attr">#[derive(Debug, Clone)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>FlateEncoderParams {
<a href=#7 id=7 data-nosnippet>7</a> inner: flate2::Compression,
<a href=#8 id=8 data-nosnippet>8</a>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>From&lt;flate2::Compression&gt; <span class="kw">for </span>FlateEncoderParams {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">fn </span>from(inner: flate2::Compression) -&gt; <span class="self">Self </span>{
<a href=#12 id=12 data-nosnippet>12</a> <span class="self">Self </span>{ inner }
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a>}
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">impl </span>From&lt;FlateEncoderParams&gt; <span class="kw">for </span>flate2::Compression {
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">fn </span>from(value: FlateEncoderParams) -&gt; <span class="self">Self </span>{
<a href=#17 id=17 data-nosnippet>17</a> value.inner
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a>}
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">impl </span>From&lt;Level&gt; <span class="kw">for </span>FlateEncoderParams {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">fn </span>from(value: Level) -&gt; <span class="self">Self </span>{
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>fastest = flate2::Compression::fast();
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span>best = flate2::Compression::best();
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">let </span>none = flate2::Compression::none();
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>inner = <span class="kw">match </span>value {
<a href=#28 id=28 data-nosnippet>28</a> Level::Fastest =&gt; fastest,
<a href=#29 id=29 data-nosnippet>29</a> Level::Best =&gt; best,
<a href=#30 id=30 data-nosnippet>30</a> Level::Precise(quality) =&gt; flate2::Compression::new(
<a href=#31 id=31 data-nosnippet>31</a> quality
<a href=#32 id=32 data-nosnippet>32</a> .try_into()
<a href=#33 id=33 data-nosnippet>33</a> .unwrap_or(<span class="number">0</span>)
<a href=#34 id=34 data-nosnippet>34</a> .clamp(none.level(), best.level()),
<a href=#35 id=35 data-nosnippet>35</a> ),
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">_ </span>=&gt; flate2::Compression::default(),
<a href=#37 id=37 data-nosnippet>37</a> };
<a href=#38 id=38 data-nosnippet>38</a> <span class="self">Self </span>{ inner }
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,161 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/gzip/decoder.rs`."><title>decoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/gzip/</div>decoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span><span class="kw">super</span>::header;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use crate</span>::{DecodeV2, FlateDecoder};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>flate2::Crc;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::io::{Error, ErrorKind, <span class="prelude-ty">Result</span>};
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="attr">#[derive(Debug)]
<a href=#8 id=8 data-nosnippet>8</a></span><span class="kw">enum </span>State {
<a href=#9 id=9 data-nosnippet>9</a> Header(header::Parser),
<a href=#10 id=10 data-nosnippet>10</a> Decoding,
<a href=#11 id=11 data-nosnippet>11</a> Footer(PartialBuffer&lt;[u8; <span class="number">8</span>]&gt;),
<a href=#12 id=12 data-nosnippet>12</a> Done,
<a href=#13 id=13 data-nosnippet>13</a>}
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="attr">#[derive(Debug)]
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">pub struct </span>GzipDecoder {
<a href=#17 id=17 data-nosnippet>17</a> inner: FlateDecoder,
<a href=#18 id=18 data-nosnippet>18</a> crc: Crc,
<a href=#19 id=19 data-nosnippet>19</a> state: State,
<a href=#20 id=20 data-nosnippet>20</a>}
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">fn </span>check_footer(crc: <span class="kw-2">&amp;</span>Crc, input: <span class="kw-2">&amp;</span>[u8; <span class="number">8</span>]) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>crc_sum = crc.sum().to_le_bytes();
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span>bytes_read = crc.amount().to_le_bytes();
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">if </span><span class="macro">crc_sum !</span>= input[<span class="number">0</span>..<span class="number">4</span>] {
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::new(
<a href=#28 id=28 data-nosnippet>28</a> ErrorKind::InvalidData,
<a href=#29 id=29 data-nosnippet>29</a> <span class="string">"CRC computed does not match"</span>,
<a href=#30 id=30 data-nosnippet>30</a> ));
<a href=#31 id=31 data-nosnippet>31</a> }
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">if </span><span class="macro">bytes_read !</span>= input[<span class="number">4</span>..<span class="number">8</span>] {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::new(
<a href=#35 id=35 data-nosnippet>35</a> ErrorKind::InvalidData,
<a href=#36 id=36 data-nosnippet>36</a> <span class="string">"amount of bytes read does not match"</span>,
<a href=#37 id=37 data-nosnippet>37</a> ));
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="prelude-val">Ok</span>(())
<a href=#41 id=41 data-nosnippet>41</a>}
<a href=#42 id=42 data-nosnippet>42</a>
<a href=#43 id=43 data-nosnippet>43</a><span class="kw">impl </span>Default <span class="kw">for </span>GzipDecoder {
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#45 id=45 data-nosnippet>45</a> <span class="self">Self </span>{
<a href=#46 id=46 data-nosnippet>46</a> inner: FlateDecoder::new(<span class="bool-val">false</span>),
<a href=#47 id=47 data-nosnippet>47</a> crc: Crc::new(),
<a href=#48 id=48 data-nosnippet>48</a> state: State::Header(header::Parser::default()),
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>}
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a><span class="kw">impl </span>GzipDecoder {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<a href=#55 id=55 data-nosnippet>55</a> <span class="self">Self</span>::default()
<a href=#56 id=56 data-nosnippet>56</a> }
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">fn </span>process(
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#60 id=60 data-nosnippet>60</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#61 id=61 data-nosnippet>61</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#62 id=62 data-nosnippet>62</a> inner: <span class="kw">impl </span>Fn(<span class="kw-2">&amp;mut </span><span class="self">Self</span>, <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;, <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;,
<a href=#63 id=63 data-nosnippet>63</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">loop </span>{
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">match </span><span class="kw-2">&amp;mut </span><span class="self">self</span>.state {
<a href=#66 id=66 data-nosnippet>66</a> State::Header(parser) =&gt; {
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">if </span>parser.input(<span class="kw-2">&amp;mut </span><span class="self">self</span>.crc, input)<span class="question-mark">?</span>.is_some() {
<a href=#68 id=68 data-nosnippet>68</a> <span class="self">self</span>.crc.reset();
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">self</span>.state = State::Decoding;
<a href=#70 id=70 data-nosnippet>70</a> }
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> State::Decoding =&gt; {
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>prior = output.written_len();
<a href=#75 id=75 data-nosnippet>75</a>
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span>res = inner(<span class="self">self</span>, input, output);
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">if </span>output.written_len() &gt; prior {
<a href=#79 id=79 data-nosnippet>79</a> <span class="comment">// update CRC even if there was an error
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="self">self</span>.crc.update(<span class="kw-2">&amp;</span>output.written()[prior..]);
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>done = res<span class="question-mark">?</span>;
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if </span>done {
<a href=#86 id=86 data-nosnippet>86</a> <span class="self">self</span>.state = State::Footer([<span class="number">0</span>; <span class="number">8</span>].into());
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a> }
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a> State::Footer(footer) =&gt; {
<a href=#91 id=91 data-nosnippet>91</a> footer.copy_unwritten_from(input);
<a href=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">if </span>footer.unwritten().is_empty() {
<a href=#94 id=94 data-nosnippet>94</a> check_footer(<span class="kw-2">&amp;</span><span class="self">self</span>.crc, footer.get_mut())<span class="question-mark">?</span>;
<a href=#95 id=95 data-nosnippet>95</a> <span class="self">self</span>.state = State::Done;
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> State::Done =&gt; {}
<a href=#100 id=100 data-nosnippet>100</a> };
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">if let </span>State::Done = <span class="self">self</span>.state {
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">true</span>);
<a href=#104 id=104 data-nosnippet>104</a> }
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">if </span>input.unwritten().is_empty() || output.has_no_spare_space() {
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">false</span>);
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a>}
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a><span class="kw">impl </span>DecodeV2 <span class="kw">for </span>GzipDecoder {
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#115 id=115 data-nosnippet>115</a> <span class="self">self</span>.inner.reinit()<span class="question-mark">?</span>;
<a href=#116 id=116 data-nosnippet>116</a> <span class="self">self</span>.crc.reset();
<a href=#117 id=117 data-nosnippet>117</a> <span class="self">self</span>.state = State::Header(header::Parser::default());
<a href=#118 id=118 data-nosnippet>118</a> <span class="prelude-val">Ok</span>(())
<a href=#119 id=119 data-nosnippet>119</a> }
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">fn </span>decode(
<a href=#122 id=122 data-nosnippet>122</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#123 id=123 data-nosnippet>123</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#124 id=124 data-nosnippet>124</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#125 id=125 data-nosnippet>125</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#126 id=126 data-nosnippet>126</a> <span class="self">self</span>.process(input, output, |this, input, output| {
<a href=#127 id=127 data-nosnippet>127</a> this.inner.decode(input, output)
<a href=#128 id=128 data-nosnippet>128</a> })
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">loop </span>{
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">match </span><span class="self">self</span>.state {
<a href=#134 id=134 data-nosnippet>134</a> State::Header(<span class="kw">_</span>) | State::Footer(<span class="kw">_</span>) | State::Done =&gt; <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> State::Decoding =&gt; {
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>prior = output.written_len();
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">let </span>done = <span class="self">self</span>.inner.flush(output)<span class="question-mark">?</span>;
<a href=#139 id=139 data-nosnippet>139</a> <span class="self">self</span>.crc.update(<span class="kw-2">&amp;</span>output.written()[prior..]);
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">if </span>done {
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">true</span>);
<a href=#142 id=142 data-nosnippet>142</a> }
<a href=#143 id=143 data-nosnippet>143</a> }
<a href=#144 id=144 data-nosnippet>144</a> };
<a href=#145 id=145 data-nosnippet>145</a>
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">if </span>output.has_no_spare_space() {
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">false</span>);
<a href=#148 id=148 data-nosnippet>148</a> }
<a href=#149 id=149 data-nosnippet>149</a> }
<a href=#150 id=150 data-nosnippet>150</a> }
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, _output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#153 id=153 data-nosnippet>153</a> <span class="comment">// Because of the footer we have to have already flushed all the data out before we get here
<a href=#154 id=154 data-nosnippet>154</a> </span><span class="kw">if let </span>State::Done = <span class="self">self</span>.state {
<a href=#155 id=155 data-nosnippet>155</a> <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>)
<a href=#156 id=156 data-nosnippet>156</a> } <span class="kw">else </span>{
<a href=#157 id=157 data-nosnippet>157</a> <span class="prelude-val">Err</span>(Error::from(ErrorKind::UnexpectedEof))
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a> }
<a href=#160 id=160 data-nosnippet>160</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,161 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/gzip/encoder.rs`."><title>encoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/gzip/</div>encoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{flate::params::FlateEncoderParams, EncodeV2, FlateEncoder};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>flate2::{Compression, Crc};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::io;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="attr">#[derive(Debug)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">enum </span>State {
<a href=#8 id=8 data-nosnippet>8</a> Header(PartialBuffer&lt;[u8; <span class="number">10</span>]&gt;),
<a href=#9 id=9 data-nosnippet>9</a> Encoding,
<a href=#10 id=10 data-nosnippet>10</a> Footer(PartialBuffer&lt;[u8; <span class="number">8</span>]&gt;),
<a href=#11 id=11 data-nosnippet>11</a> Done,
<a href=#12 id=12 data-nosnippet>12</a>}
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="attr">#[derive(Debug)]
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub struct </span>GzipEncoder {
<a href=#16 id=16 data-nosnippet>16</a> inner: FlateEncoder,
<a href=#17 id=17 data-nosnippet>17</a> crc: Crc,
<a href=#18 id=18 data-nosnippet>18</a> state: State,
<a href=#19 id=19 data-nosnippet>19</a>}
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">fn </span>header(level: Compression) -&gt; [u8; <span class="number">10</span>] {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>level_byte = <span class="kw">if </span>level.level() &gt;= Compression::best().level() {
<a href=#23 id=23 data-nosnippet>23</a> <span class="number">0x02
<a href=#24 id=24 data-nosnippet>24</a> </span>} <span class="kw">else if </span>level.level() &lt;= Compression::fast().level() {
<a href=#25 id=25 data-nosnippet>25</a> <span class="number">0x04
<a href=#26 id=26 data-nosnippet>26</a> </span>} <span class="kw">else </span>{
<a href=#27 id=27 data-nosnippet>27</a> <span class="number">0x00
<a href=#28 id=28 data-nosnippet>28</a> </span>};
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a> [<span class="number">0x1f</span>, <span class="number">0x8b</span>, <span class="number">0x08</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, level_byte, <span class="number">0xff</span>]
<a href=#31 id=31 data-nosnippet>31</a>}
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">impl </span>GzipEncoder {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">pub fn </span>new(level: FlateEncoderParams) -&gt; <span class="self">Self </span>{
<a href=#35 id=35 data-nosnippet>35</a> <span class="self">Self </span>{
<a href=#36 id=36 data-nosnippet>36</a> inner: FlateEncoder::new(level.clone(), <span class="bool-val">false</span>),
<a href=#37 id=37 data-nosnippet>37</a> crc: Crc::new(),
<a href=#38 id=38 data-nosnippet>38</a> state: State::Header(header(Compression::from(level)).into()),
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a> }
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">fn </span>footer(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; [u8; <span class="number">8</span>] {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span><span class="kw-2">mut </span>output = [<span class="number">0</span>; <span class="number">8</span>];
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a> output[..<span class="number">4</span>].copy_from_slice(<span class="kw-2">&amp;</span><span class="self">self</span>.crc.sum().to_le_bytes());
<a href=#46 id=46 data-nosnippet>46</a> output[<span class="number">4</span>..].copy_from_slice(<span class="kw-2">&amp;</span><span class="self">self</span>.crc.amount().to_le_bytes());
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a> output
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a>}
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a><span class="kw">impl </span>EncodeV2 <span class="kw">for </span>GzipEncoder {
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">fn </span>encode(
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#55 id=55 data-nosnippet>55</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#56 id=56 data-nosnippet>56</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#57 id=57 data-nosnippet>57</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">loop </span>{
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">match </span><span class="kw-2">&amp;mut </span><span class="self">self</span>.state {
<a href=#60 id=60 data-nosnippet>60</a> State::Header(header) =&gt; {
<a href=#61 id=61 data-nosnippet>61</a> output.copy_unwritten_from(<span class="kw-2">&amp;mut *</span>header);
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">if </span>header.unwritten().is_empty() {
<a href=#64 id=64 data-nosnippet>64</a> <span class="self">self</span>.state = State::Encoding;
<a href=#65 id=65 data-nosnippet>65</a> }
<a href=#66 id=66 data-nosnippet>66</a> }
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> State::Encoding =&gt; {
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">let </span>prior_written = input.written().len();
<a href=#70 id=70 data-nosnippet>70</a> <span class="self">self</span>.inner.encode(input, output)<span class="question-mark">?</span>;
<a href=#71 id=71 data-nosnippet>71</a> <span class="self">self</span>.crc.update(<span class="kw-2">&amp;</span>input.written()[prior_written..]);
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> State::Footer(<span class="kw">_</span>) | State::Done =&gt; {
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::other(<span class="string">"encode after complete"</span>));
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a> };
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">if </span>input.unwritten().is_empty() || output.has_no_spare_space() {
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(());
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">loop </span>{
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">let </span>done = <span class="kw">match </span><span class="kw-2">&amp;mut </span><span class="self">self</span>.state {
<a href=#88 id=88 data-nosnippet>88</a> State::Header(header) =&gt; {
<a href=#89 id=89 data-nosnippet>89</a> output.copy_unwritten_from(<span class="kw-2">&amp;mut *</span>header);
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">if </span>header.unwritten().is_empty() {
<a href=#92 id=92 data-nosnippet>92</a> <span class="self">self</span>.state = State::Encoding;
<a href=#93 id=93 data-nosnippet>93</a> }
<a href=#94 id=94 data-nosnippet>94</a> <span class="bool-val">false
<a href=#95 id=95 data-nosnippet>95</a> </span>}
<a href=#96 id=96 data-nosnippet>96</a>
<a href=#97 id=97 data-nosnippet>97</a> State::Encoding =&gt; <span class="self">self</span>.inner.flush(output)<span class="question-mark">?</span>,
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> State::Footer(footer) =&gt; {
<a href=#100 id=100 data-nosnippet>100</a> output.copy_unwritten_from(<span class="kw-2">&amp;mut *</span>footer);
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">if </span>footer.unwritten().is_empty() {
<a href=#103 id=103 data-nosnippet>103</a> <span class="self">self</span>.state = State::Done;
<a href=#104 id=104 data-nosnippet>104</a> <span class="bool-val">true
<a href=#105 id=105 data-nosnippet>105</a> </span>} <span class="kw">else </span>{
<a href=#106 id=106 data-nosnippet>106</a> <span class="bool-val">false
<a href=#107 id=107 data-nosnippet>107</a> </span>}
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> State::Done =&gt; <span class="bool-val">true</span>,
<a href=#111 id=111 data-nosnippet>111</a> };
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">if </span>done {
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">true</span>);
<a href=#115 id=115 data-nosnippet>115</a> }
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">if </span>output.has_no_spare_space() {
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">false</span>);
<a href=#119 id=119 data-nosnippet>119</a> }
<a href=#120 id=120 data-nosnippet>120</a> }
<a href=#121 id=121 data-nosnippet>121</a> }
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">loop </span>{
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">match </span><span class="kw-2">&amp;mut </span><span class="self">self</span>.state {
<a href=#126 id=126 data-nosnippet>126</a> State::Header(header) =&gt; {
<a href=#127 id=127 data-nosnippet>127</a> output.copy_unwritten_from(<span class="kw-2">&amp;mut *</span>header);
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">if </span>header.unwritten().is_empty() {
<a href=#130 id=130 data-nosnippet>130</a> <span class="self">self</span>.state = State::Encoding;
<a href=#131 id=131 data-nosnippet>131</a> }
<a href=#132 id=132 data-nosnippet>132</a> }
<a href=#133 id=133 data-nosnippet>133</a>
<a href=#134 id=134 data-nosnippet>134</a> State::Encoding =&gt; {
<a href=#135 id=135 data-nosnippet>135</a> <span class="kw">if </span><span class="self">self</span>.inner.finish(output)<span class="question-mark">? </span>{
<a href=#136 id=136 data-nosnippet>136</a> <span class="self">self</span>.state = State::Footer(<span class="self">self</span>.footer().into());
<a href=#137 id=137 data-nosnippet>137</a> }
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a>
<a href=#140 id=140 data-nosnippet>140</a> State::Footer(footer) =&gt; {
<a href=#141 id=141 data-nosnippet>141</a> output.copy_unwritten_from(<span class="kw-2">&amp;mut *</span>footer);
<a href=#142 id=142 data-nosnippet>142</a>
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">if </span>footer.unwritten().is_empty() {
<a href=#144 id=144 data-nosnippet>144</a> <span class="self">self</span>.state = State::Done;
<a href=#145 id=145 data-nosnippet>145</a> }
<a href=#146 id=146 data-nosnippet>146</a> }
<a href=#147 id=147 data-nosnippet>147</a>
<a href=#148 id=148 data-nosnippet>148</a> State::Done =&gt; {}
<a href=#149 id=149 data-nosnippet>149</a> };
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">if let </span>State::Done = <span class="self">self</span>.state {
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">true</span>);
<a href=#153 id=153 data-nosnippet>153</a> }
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">if </span>output.has_no_spare_space() {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="bool-val">false</span>);
<a href=#157 id=157 data-nosnippet>157</a> }
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a> }
<a href=#160 id=160 data-nosnippet>160</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,190 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/gzip/header.rs`."><title>header.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/gzip/</div>header.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>compression_core::util::PartialBuffer;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>flate2::Crc;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::io;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="attr">#[derive(Debug, Default)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">struct </span>Flags {
<a href=#7 id=7 data-nosnippet>7</a> _ascii: bool,
<a href=#8 id=8 data-nosnippet>8</a> crc: bool,
<a href=#9 id=9 data-nosnippet>9</a> extra: bool,
<a href=#10 id=10 data-nosnippet>10</a> filename: bool,
<a href=#11 id=11 data-nosnippet>11</a> comment: bool,
<a href=#12 id=12 data-nosnippet>12</a>}
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="attr">#[derive(Debug, Default)]
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Header {
<a href=#16 id=16 data-nosnippet>16</a> flags: Flags,
<a href=#17 id=17 data-nosnippet>17</a>}
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="attr">#[derive(Debug)]
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">enum </span>State {
<a href=#21 id=21 data-nosnippet>21</a> Fixed(PartialBuffer&lt;[u8; <span class="number">10</span>]&gt;),
<a href=#22 id=22 data-nosnippet>22</a> ExtraLen(PartialBuffer&lt;[u8; <span class="number">2</span>]&gt;),
<a href=#23 id=23 data-nosnippet>23</a> Extra(usize),
<a href=#24 id=24 data-nosnippet>24</a> Filename,
<a href=#25 id=25 data-nosnippet>25</a> Comment,
<a href=#26 id=26 data-nosnippet>26</a> Crc(PartialBuffer&lt;[u8; <span class="number">2</span>]&gt;),
<a href=#27 id=27 data-nosnippet>27</a> Done,
<a href=#28 id=28 data-nosnippet>28</a>}
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">impl </span>Default <span class="kw">for </span>State {
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#32 id=32 data-nosnippet>32</a> State::Fixed(&lt;<span class="kw">_</span>&gt;::default())
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>}
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="attr">#[derive(Debug, Default)]
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Parser {
<a href=#38 id=38 data-nosnippet>38</a> state: State,
<a href=#39 id=39 data-nosnippet>39</a> header: Header,
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="kw">impl </span>Header {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">fn </span>parse(input: <span class="kw-2">&amp;</span>[u8; <span class="number">10</span>]) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">if </span>input[<span class="number">0</span>..<span class="number">3</span>] != [<span class="number">0x1f</span>, <span class="number">0x8b</span>, <span class="number">0x08</span>] {
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(
<a href=#46 id=46 data-nosnippet>46</a> io::ErrorKind::InvalidData,
<a href=#47 id=47 data-nosnippet>47</a> <span class="string">"Invalid gzip header"</span>,
<a href=#48 id=48 data-nosnippet>48</a> ));
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span>flag = input[<span class="number">3</span>];
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">let </span>flags = Flags {
<a href=#54 id=54 data-nosnippet>54</a> _ascii: (flag &amp; <span class="number">0b0000_0001</span>) != <span class="number">0</span>,
<a href=#55 id=55 data-nosnippet>55</a> crc: (flag &amp; <span class="number">0b0000_0010</span>) != <span class="number">0</span>,
<a href=#56 id=56 data-nosnippet>56</a> extra: (flag &amp; <span class="number">0b0000_0100</span>) != <span class="number">0</span>,
<a href=#57 id=57 data-nosnippet>57</a> filename: (flag &amp; <span class="number">0b0000_1000</span>) != <span class="number">0</span>,
<a href=#58 id=58 data-nosnippet>58</a> comment: (flag &amp; <span class="number">0b0001_0000</span>) != <span class="number">0</span>,
<a href=#59 id=59 data-nosnippet>59</a> };
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="prelude-val">Ok</span>(Header { flags })
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a>}
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a><span class="kw">fn </span>consume_input(crc: <span class="kw-2">&amp;mut </span>Crc, n: usize, input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;) {
<a href=#66 id=66 data-nosnippet>66</a> crc.update(<span class="kw-2">&amp;</span>input.unwritten()[..n]);
<a href=#67 id=67 data-nosnippet>67</a> input.advance(n);
<a href=#68 id=68 data-nosnippet>68</a>}
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">fn </span>consume_cstr(crc: <span class="kw-2">&amp;mut </span>Crc, input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;()&gt; {
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(len) = memchr::memchr(<span class="number">0</span>, input.unwritten()) {
<a href=#72 id=72 data-nosnippet>72</a> consume_input(crc, len + <span class="number">1</span>, input);
<a href=#73 id=73 data-nosnippet>73</a> <span class="prelude-val">Some</span>(())
<a href=#74 id=74 data-nosnippet>74</a> } <span class="kw">else </span>{
<a href=#75 id=75 data-nosnippet>75</a> consume_input(crc, input.unwritten().len(), input);
<a href=#76 id=76 data-nosnippet>76</a> <span class="prelude-val">None
<a href=#77 id=77 data-nosnippet>77</a> </span>}
<a href=#78 id=78 data-nosnippet>78</a>}
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a><span class="kw">impl </span>Parser {
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>input(
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#83 id=83 data-nosnippet>83</a> crc: <span class="kw-2">&amp;mut </span>Crc,
<a href=#84 id=84 data-nosnippet>84</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#85 id=85 data-nosnippet>85</a> ) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;Header&gt;&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">loop </span>{
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">match </span><span class="kw-2">&amp;mut </span><span class="self">self</span>.state {
<a href=#88 id=88 data-nosnippet>88</a> State::Fixed(data) =&gt; {
<a href=#89 id=89 data-nosnippet>89</a> data.copy_unwritten_from(input);
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">if </span>data.unwritten().is_empty() {
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">let </span>data = data.get_mut();
<a href=#93 id=93 data-nosnippet>93</a> crc.update(data);
<a href=#94 id=94 data-nosnippet>94</a> <span class="self">self</span>.header = Header::parse(data)<span class="question-mark">?</span>;
<a href=#95 id=95 data-nosnippet>95</a> <span class="self">self</span>.state = State::ExtraLen(&lt;<span class="kw">_</span>&gt;::default());
<a href=#96 id=96 data-nosnippet>96</a> } <span class="kw">else </span>{
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#98 id=98 data-nosnippet>98</a> }
<a href=#99 id=99 data-nosnippet>99</a> }
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> State::ExtraLen(data) =&gt; {
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">if </span>!<span class="self">self</span>.header.flags.extra {
<a href=#103 id=103 data-nosnippet>103</a> <span class="self">self</span>.state = State::Filename;
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">continue</span>;
<a href=#105 id=105 data-nosnippet>105</a> }
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> data.copy_unwritten_from(input);
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a> <span class="kw">if </span>data.unwritten().is_empty() {
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>data = data.get_mut();
<a href=#111 id=111 data-nosnippet>111</a> crc.update(data);
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">let </span>len = u16::from_le_bytes(<span class="kw-2">*</span>data);
<a href=#113 id=113 data-nosnippet>113</a> <span class="self">self</span>.state = State::Extra(len.into());
<a href=#114 id=114 data-nosnippet>114</a> } <span class="kw">else </span>{
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#116 id=116 data-nosnippet>116</a> }
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> State::Extra(bytes_to_consume) =&gt; {
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">let </span>n = input.unwritten().len().min(<span class="kw-2">*</span>bytes_to_consume);
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw-2">*</span>bytes_to_consume -= n;
<a href=#122 id=122 data-nosnippet>122</a> consume_input(crc, n, input);
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">if </span><span class="kw-2">*</span>bytes_to_consume == <span class="number">0 </span>{
<a href=#125 id=125 data-nosnippet>125</a> <span class="self">self</span>.state = State::Filename;
<a href=#126 id=126 data-nosnippet>126</a> } <span class="kw">else </span>{
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#128 id=128 data-nosnippet>128</a> }
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> State::Filename =&gt; {
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">if </span>!<span class="self">self</span>.header.flags.filename {
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">self</span>.state = State::Comment;
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">continue</span>;
<a href=#135 id=135 data-nosnippet>135</a> }
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">if </span>consume_cstr(crc, input).is_none() {
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#139 id=139 data-nosnippet>139</a> }
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a> <span class="self">self</span>.state = State::Comment;
<a href=#142 id=142 data-nosnippet>142</a> }
<a href=#143 id=143 data-nosnippet>143</a>
<a href=#144 id=144 data-nosnippet>144</a> State::Comment =&gt; {
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">if </span>!<span class="self">self</span>.header.flags.comment {
<a href=#146 id=146 data-nosnippet>146</a> <span class="self">self</span>.state = State::Crc(&lt;<span class="kw">_</span>&gt;::default());
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">continue</span>;
<a href=#148 id=148 data-nosnippet>148</a> }
<a href=#149 id=149 data-nosnippet>149</a>
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">if </span>consume_cstr(crc, input).is_none() {
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="self">self</span>.state = State::Crc(&lt;<span class="kw">_</span>&gt;::default());
<a href=#155 id=155 data-nosnippet>155</a> }
<a href=#156 id=156 data-nosnippet>156</a>
<a href=#157 id=157 data-nosnippet>157</a> State::Crc(data) =&gt; {
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">let </span>header = std::mem::take(<span class="kw-2">&amp;mut </span><span class="self">self</span>.header);
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">if </span>!<span class="self">self</span>.header.flags.crc {
<a href=#161 id=161 data-nosnippet>161</a> <span class="self">self</span>.state = State::Done;
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">break </span><span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(header));
<a href=#163 id=163 data-nosnippet>163</a> }
<a href=#164 id=164 data-nosnippet>164</a>
<a href=#165 id=165 data-nosnippet>165</a> data.copy_unwritten_from(input);
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">break if </span>data.unwritten().is_empty() {
<a href=#168 id=168 data-nosnippet>168</a> <span class="kw">let </span>data = data.take().into_inner();
<a href=#169 id=169 data-nosnippet>169</a> <span class="self">self</span>.state = State::Done;
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span>checksum = crc.sum().to_le_bytes();
<a href=#171 id=171 data-nosnippet>171</a>
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">if </span>data == checksum[..<span class="number">2</span>] {
<a href=#173 id=173 data-nosnippet>173</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(header))
<a href=#174 id=174 data-nosnippet>174</a> } <span class="kw">else </span>{
<a href=#175 id=175 data-nosnippet>175</a> <span class="prelude-val">Err</span>(io::Error::new(
<a href=#176 id=176 data-nosnippet>176</a> io::ErrorKind::InvalidData,
<a href=#177 id=177 data-nosnippet>177</a> <span class="string">"CRC computed for header does not match"</span>,
<a href=#178 id=178 data-nosnippet>178</a> ))
<a href=#179 id=179 data-nosnippet>179</a> }
<a href=#180 id=180 data-nosnippet>180</a> } <span class="kw">else </span>{
<a href=#181 id=181 data-nosnippet>181</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
<a href=#182 id=182 data-nosnippet>182</a> };
<a href=#183 id=183 data-nosnippet>183</a> }
<a href=#184 id=184 data-nosnippet>184</a>
<a href=#185 id=185 data-nosnippet>185</a> State::Done =&gt; <span class="kw">break </span><span class="prelude-val">Err</span>(io::Error::other(<span class="string">"parser used after done"</span>)),
<a href=#186 id=186 data-nosnippet>186</a> }
<a href=#187 id=187 data-nosnippet>187</a> }
<a href=#188 id=188 data-nosnippet>188</a> }
<a href=#189 id=189 data-nosnippet>189</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,6 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/gzip/mod.rs`."><title>mod.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/gzip/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-1"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>decoder;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">mod </span>encoder;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">mod </span>header;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub use </span><span class="self">self</span>::{decoder::GzipDecoder, encoder::GzipEncoder};
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,235 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/lib.rs`."><title>lib.rs - source</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="compression_codecs" 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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Adaptors for various compression algorithms.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="attr">#![cfg_attr(docsrs, feature(doc_cfg))]
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">use </span>std::io::Result;
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">pub use </span>compression_core <span class="kw">as </span>core;
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="attr">#[cfg(feature = <span class="string">"brotli"</span>)]
<a href=#10 id=10 data-nosnippet>10</a></span><span class="kw">pub mod </span>brotli;
<a href=#11 id=11 data-nosnippet>11</a><span class="attr">#[cfg(feature = <span class="string">"bzip2"</span>)]
<a href=#12 id=12 data-nosnippet>12</a></span><span class="kw">pub mod </span>bzip2;
<a href=#13 id=13 data-nosnippet>13</a><span class="attr">#[cfg(feature = <span class="string">"deflate"</span>)]
<a href=#14 id=14 data-nosnippet>14</a></span><span class="kw">pub mod </span>deflate;
<a href=#15 id=15 data-nosnippet>15</a><span class="attr">#[cfg(feature = <span class="string">"deflate64"</span>)]
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">pub mod </span>deflate64;
<a href=#17 id=17 data-nosnippet>17</a><span class="attr">#[cfg(feature = <span class="string">"flate2"</span>)]
<a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">pub mod </span>flate;
<a href=#19 id=19 data-nosnippet>19</a><span class="attr">#[cfg(feature = <span class="string">"gzip"</span>)]
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">pub mod </span>gzip;
<a href=#21 id=21 data-nosnippet>21</a><span class="attr">#[cfg(feature = <span class="string">"lz4"</span>)]
<a href=#22 id=22 data-nosnippet>22</a></span><span class="kw">pub mod </span>lz4;
<a href=#23 id=23 data-nosnippet>23</a><span class="attr">#[cfg(feature = <span class="string">"lzma"</span>)]
<a href=#24 id=24 data-nosnippet>24</a></span><span class="kw">pub mod </span>lzma;
<a href=#25 id=25 data-nosnippet>25</a><span class="attr">#[cfg(feature = <span class="string">"xz"</span>)]
<a href=#26 id=26 data-nosnippet>26</a></span><span class="kw">pub mod </span>xz;
<a href=#27 id=27 data-nosnippet>27</a><span class="attr">#[cfg(feature = <span class="string">"lzma"</span>)]
<a href=#28 id=28 data-nosnippet>28</a></span><span class="kw">pub mod </span>xz2;
<a href=#29 id=29 data-nosnippet>29</a><span class="attr">#[cfg(feature = <span class="string">"zlib"</span>)]
<a href=#30 id=30 data-nosnippet>30</a></span><span class="kw">pub mod </span>zlib;
<a href=#31 id=31 data-nosnippet>31</a><span class="attr">#[cfg(feature = <span class="string">"zstd"</span>)]
<a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">pub mod </span>zstd;
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="attr">#[cfg(feature = <span class="string">"brotli"</span>)]
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub use </span><span class="self">self</span>::brotli::{BrotliDecoder, BrotliEncoder};
<a href=#38 id=38 data-nosnippet>38</a><span class="attr">#[cfg(feature = <span class="string">"bzip2"</span>)]
<a href=#39 id=39 data-nosnippet>39</a></span><span class="kw">pub use </span><span class="self">self</span>::bzip2::{BzDecoder, BzEncoder};
<a href=#40 id=40 data-nosnippet>40</a><span class="attr">#[cfg(feature = <span class="string">"deflate"</span>)]
<a href=#41 id=41 data-nosnippet>41</a></span><span class="kw">pub use </span><span class="self">self</span>::deflate::{DeflateDecoder, DeflateEncoder};
<a href=#42 id=42 data-nosnippet>42</a><span class="attr">#[cfg(feature = <span class="string">"deflate64"</span>)]
<a href=#43 id=43 data-nosnippet>43</a></span><span class="kw">pub use </span><span class="self">self</span>::deflate64::Deflate64Decoder;
<a href=#44 id=44 data-nosnippet>44</a><span class="attr">#[cfg(feature = <span class="string">"flate2"</span>)]
<a href=#45 id=45 data-nosnippet>45</a></span><span class="kw">pub use </span><span class="self">self</span>::flate::{FlateDecoder, FlateEncoder};
<a href=#46 id=46 data-nosnippet>46</a><span class="attr">#[cfg(feature = <span class="string">"gzip"</span>)]
<a href=#47 id=47 data-nosnippet>47</a></span><span class="kw">pub use </span><span class="self">self</span>::gzip::{GzipDecoder, GzipEncoder};
<a href=#48 id=48 data-nosnippet>48</a><span class="attr">#[cfg(feature = <span class="string">"lz4"</span>)]
<a href=#49 id=49 data-nosnippet>49</a></span><span class="kw">pub use </span><span class="self">self</span>::lz4::{Lz4Decoder, Lz4Encoder};
<a href=#50 id=50 data-nosnippet>50</a><span class="attr">#[cfg(feature = <span class="string">"lzma"</span>)]
<a href=#51 id=51 data-nosnippet>51</a></span><span class="kw">pub use </span><span class="self">self</span>::lzma::{LzmaDecoder, LzmaEncoder};
<a href=#52 id=52 data-nosnippet>52</a><span class="attr">#[cfg(feature = <span class="string">"xz"</span>)]
<a href=#53 id=53 data-nosnippet>53</a></span><span class="kw">pub use </span><span class="self">self</span>::xz::{XzDecoder, XzEncoder};
<a href=#54 id=54 data-nosnippet>54</a><span class="attr">#[cfg(feature = <span class="string">"lzma"</span>)]
<a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">pub use </span><span class="self">self</span>::xz2::{Xz2Decoder, Xz2Encoder, Xz2FileFormat};
<a href=#56 id=56 data-nosnippet>56</a><span class="attr">#[cfg(feature = <span class="string">"zlib"</span>)]
<a href=#57 id=57 data-nosnippet>57</a></span><span class="kw">pub use </span><span class="self">self</span>::zlib::{ZlibDecoder, ZlibEncoder};
<a href=#58 id=58 data-nosnippet>58</a><span class="attr">#[cfg(feature = <span class="string">"zstd"</span>)]
<a href=#59 id=59 data-nosnippet>59</a></span><span class="kw">pub use </span><span class="self">self</span>::zstd::{ZstdDecoder, ZstdEncoder};
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a><span class="kw">fn </span>forward_output&lt;R&gt;(
<a href=#62 id=62 data-nosnippet>62</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#63 id=63 data-nosnippet>63</a> f: <span class="kw">impl </span>FnOnce(<span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; R,
<a href=#64 id=64 data-nosnippet>64</a>) -&gt; R {
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>written_len = output.written_len();
<a href=#66 id=66 data-nosnippet>66</a>
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>output_buffer = output.get_mut();
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span><span class="kw-2">mut </span>write_buffer = WriteBuffer::new_initialized(output_buffer.as_mut());
<a href=#69 id=69 data-nosnippet>69</a> write_buffer.advance(written_len);
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">let </span>result = f(<span class="kw-2">&amp;mut </span>write_buffer);
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>new_written_len = write_buffer.written_len();
<a href=#73 id=73 data-nosnippet>73</a> output.advance(new_written_len - written_len);
<a href=#74 id=74 data-nosnippet>74</a> result
<a href=#75 id=75 data-nosnippet>75</a>}
<a href=#76 id=76 data-nosnippet>76</a>
<a href=#77 id=77 data-nosnippet>77</a><span class="kw">fn </span>forward_input_output&lt;R&gt;(
<a href=#78 id=78 data-nosnippet>78</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt;&gt;,
<a href=#79 id=79 data-nosnippet>79</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#80 id=80 data-nosnippet>80</a> f: <span class="kw">impl </span>FnOnce(<span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;, <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; R,
<a href=#81 id=81 data-nosnippet>81</a>) -&gt; R {
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span>written_len = input.written_len();
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span>input_buffer = input.get_mut();
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">let </span><span class="kw-2">mut </span>partial_buffer = PartialBuffer::new(input_buffer.as_ref());
<a href=#86 id=86 data-nosnippet>86</a> partial_buffer.advance(written_len);
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">let </span>result = forward_output(output, |output| f(<span class="kw-2">&amp;mut </span>partial_buffer, output));
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>new_written_len = partial_buffer.written_len();
<a href=#90 id=90 data-nosnippet>90</a> input.advance(new_written_len - written_len);
<a href=#91 id=91 data-nosnippet>91</a> result
<a href=#92 id=92 data-nosnippet>92</a>}
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a><span class="kw">pub trait </span>Encode {
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">fn </span>encode(
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#97 id=97 data-nosnippet>97</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt;&gt;,
<a href=#98 id=98 data-nosnippet>98</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#99 id=99 data-nosnippet>99</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt;;
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="doccomment">/// Returns whether the internal buffers are flushed
<a href=#102 id=102 data-nosnippet>102</a> </span><span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;)
<a href=#103 id=103 data-nosnippet>103</a> -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="doccomment">/// Returns whether the internal buffers are flushed and the end of the stream is written
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">fn </span>finish(
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#108 id=108 data-nosnippet>108</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#109 id=109 data-nosnippet>109</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#110 id=110 data-nosnippet>110</a>}
<a href=#111 id=111 data-nosnippet>111</a><span class="kw">impl</span>&lt;T: EncodeV2 + <span class="question-mark">?</span>Sized&gt; Encode <span class="kw">for </span>T {
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">fn </span>encode(
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#114 id=114 data-nosnippet>114</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt;&gt;,
<a href=#115 id=115 data-nosnippet>115</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#116 id=116 data-nosnippet>116</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#117 id=117 data-nosnippet>117</a> forward_input_output(input, output, |input, output| {
<a href=#118 id=118 data-nosnippet>118</a> EncodeV2::encode(<span class="self">self</span>, input, output)
<a href=#119 id=119 data-nosnippet>119</a> })
<a href=#120 id=120 data-nosnippet>120</a> }
<a href=#121 id=121 data-nosnippet>121</a>
<a href=#122 id=122 data-nosnippet>122</a> <span class="kw">fn </span>flush(
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#124 id=124 data-nosnippet>124</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#125 id=125 data-nosnippet>125</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#126 id=126 data-nosnippet>126</a> forward_output(output, |output| EncodeV2::flush(<span class="self">self</span>, output))
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">fn </span>finish(
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#131 id=131 data-nosnippet>131</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#132 id=132 data-nosnippet>132</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#133 id=133 data-nosnippet>133</a> forward_output(output, |output| EncodeV2::finish(<span class="self">self</span>, output))
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>}
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a><span class="doccomment">/// version 2 of [`Encode`] that is trait object safe.
<a href=#138 id=138 data-nosnippet>138</a>///
<a href=#139 id=139 data-nosnippet>139</a>/// The different from [`Encode`] is that:
<a href=#140 id=140 data-nosnippet>140</a>/// - It doesn't have any generic in it, so it is trait object safe
<a href=#141 id=141 data-nosnippet>141</a>/// - It uses [`WriteBuffer`] for output, which will support uninitialized buffer.
<a href=#142 id=142 data-nosnippet>142</a></span><span class="kw">pub trait </span>EncodeV2 {
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">fn </span>encode(
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#145 id=145 data-nosnippet>145</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#146 id=146 data-nosnippet>146</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#147 id=147 data-nosnippet>147</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt;;
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a> <span class="doccomment">/// Returns whether the internal buffers are flushed
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a> <span class="doccomment">/// Returns whether the internal buffers are flushed and the end of the stream is written
<a href=#153 id=153 data-nosnippet>153</a> </span><span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#154 id=154 data-nosnippet>154</a>}
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a><span class="kw">pub trait </span>Decode {
<a href=#157 id=157 data-nosnippet>157</a> <span class="doccomment">/// Reinitializes this decoder ready to decode a new member/frame of data.
<a href=#158 id=158 data-nosnippet>158</a> </span><span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt;;
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="doccomment">/// Returns whether the end of the stream has been read
<a href=#161 id=161 data-nosnippet>161</a> </span><span class="kw">fn </span>decode(
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#163 id=163 data-nosnippet>163</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt;&gt;,
<a href=#164 id=164 data-nosnippet>164</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#165 id=165 data-nosnippet>165</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="doccomment">/// Returns whether the internal buffers are flushed
<a href=#168 id=168 data-nosnippet>168</a> </span><span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;)
<a href=#169 id=169 data-nosnippet>169</a> -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#170 id=170 data-nosnippet>170</a>
<a href=#171 id=171 data-nosnippet>171</a> <span class="doccomment">/// Returns whether the internal buffers are flushed
<a href=#172 id=172 data-nosnippet>172</a> </span><span class="kw">fn </span>finish(
<a href=#173 id=173 data-nosnippet>173</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#174 id=174 data-nosnippet>174</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#175 id=175 data-nosnippet>175</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#176 id=176 data-nosnippet>176</a>}
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a><span class="kw">impl</span>&lt;T: DecodeV2 + <span class="question-mark">?</span>Sized&gt; Decode <span class="kw">for </span>T {
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#180 id=180 data-nosnippet>180</a> DecodeV2::reinit(<span class="self">self</span>)
<a href=#181 id=181 data-nosnippet>181</a> }
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">fn </span>decode(
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#185 id=185 data-nosnippet>185</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt;&gt;,
<a href=#186 id=186 data-nosnippet>186</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#187 id=187 data-nosnippet>187</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#188 id=188 data-nosnippet>188</a> forward_input_output(input, output, |input, output| {
<a href=#189 id=189 data-nosnippet>189</a> DecodeV2::decode(<span class="self">self</span>, input, output)
<a href=#190 id=190 data-nosnippet>190</a> })
<a href=#191 id=191 data-nosnippet>191</a> }
<a href=#192 id=192 data-nosnippet>192</a>
<a href=#193 id=193 data-nosnippet>193</a> <span class="kw">fn </span>flush(
<a href=#194 id=194 data-nosnippet>194</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#195 id=195 data-nosnippet>195</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#196 id=196 data-nosnippet>196</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#197 id=197 data-nosnippet>197</a> forward_output(output, |output| DecodeV2::flush(<span class="self">self</span>, output))
<a href=#198 id=198 data-nosnippet>198</a> }
<a href=#199 id=199 data-nosnippet>199</a>
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">fn </span>finish(
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#202 id=202 data-nosnippet>202</a> output: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw">impl </span>AsRef&lt;[u8]&gt; + AsMut&lt;[u8]&gt;&gt;,
<a href=#203 id=203 data-nosnippet>203</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#204 id=204 data-nosnippet>204</a> forward_output(output, |output| DecodeV2::finish(<span class="self">self</span>, output))
<a href=#205 id=205 data-nosnippet>205</a> }
<a href=#206 id=206 data-nosnippet>206</a>}
<a href=#207 id=207 data-nosnippet>207</a>
<a href=#208 id=208 data-nosnippet>208</a><span class="doccomment">/// version 2 [`Decode`] that is trait object safe.
<a href=#209 id=209 data-nosnippet>209</a>///
<a href=#210 id=210 data-nosnippet>210</a>/// The different from [`Decode`] is that:
<a href=#211 id=211 data-nosnippet>211</a>/// - It doesn't have any generic in it, so it is trait object safe
<a href=#212 id=212 data-nosnippet>212</a>/// - It uses [`WriteBuffer`] for output, which will support uninitialized buffer.
<a href=#213 id=213 data-nosnippet>213</a></span><span class="kw">pub trait </span>DecodeV2 {
<a href=#214 id=214 data-nosnippet>214</a> <span class="doccomment">/// Reinitializes this decoder ready to decode a new member/frame of data.
<a href=#215 id=215 data-nosnippet>215</a> </span><span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt;;
<a href=#216 id=216 data-nosnippet>216</a>
<a href=#217 id=217 data-nosnippet>217</a> <span class="doccomment">/// Returns whether the end of the stream has been read
<a href=#218 id=218 data-nosnippet>218</a> </span><span class="kw">fn </span>decode(
<a href=#219 id=219 data-nosnippet>219</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#220 id=220 data-nosnippet>220</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#221 id=221 data-nosnippet>221</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#222 id=222 data-nosnippet>222</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#223 id=223 data-nosnippet>223</a>
<a href=#224 id=224 data-nosnippet>224</a> <span class="doccomment">/// Returns whether the internal buffers are flushed
<a href=#225 id=225 data-nosnippet>225</a> </span><span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#226 id=226 data-nosnippet>226</a>
<a href=#227 id=227 data-nosnippet>227</a> <span class="doccomment">/// Returns whether the internal buffers are flushed
<a href=#228 id=228 data-nosnippet>228</a> </span><span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt;;
<a href=#229 id=229 data-nosnippet>229</a>}
<a href=#230 id=230 data-nosnippet>230</a>
<a href=#231 id=231 data-nosnippet>231</a><span class="kw">pub trait </span>DecodedSize {
<a href=#232 id=232 data-nosnippet>232</a> <span class="doccomment">/// Returns the size of the input when uncompressed.
<a href=#233 id=233 data-nosnippet>233</a> </span><span class="kw">fn </span>decoded_size(input: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;u64&gt;;
<a href=#234 id=234 data-nosnippet>234</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,44 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zlib/decoder.rs`."><title>decoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zlib/</div>decoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{DecodeV2, FlateDecoder};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::io::Result;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="attr">#[derive(Debug)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>ZlibDecoder {
<a href=#7 id=7 data-nosnippet>7</a> inner: FlateDecoder,
<a href=#8 id=8 data-nosnippet>8</a>}
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">impl </span>Default <span class="kw">for </span>ZlibDecoder {
<a href=#10 id=10 data-nosnippet>10</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#11 id=11 data-nosnippet>11</a> <span class="self">Self </span>{
<a href=#12 id=12 data-nosnippet>12</a> inner: FlateDecoder::new(<span class="bool-val">true</span>),
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a> }
<a href=#15 id=15 data-nosnippet>15</a>}
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">impl </span>ZlibDecoder {
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<a href=#18 id=18 data-nosnippet>18</a> <span class="self">Self</span>::default()
<a href=#19 id=19 data-nosnippet>19</a> }
<a href=#20 id=20 data-nosnippet>20</a>}
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">impl </span>DecodeV2 <span class="kw">for </span>ZlibDecoder {
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#24 id=24 data-nosnippet>24</a> <span class="self">self</span>.inner.reinit()<span class="question-mark">?</span>;
<a href=#25 id=25 data-nosnippet>25</a> <span class="prelude-val">Ok</span>(())
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">fn </span>decode(
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#30 id=30 data-nosnippet>30</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#31 id=31 data-nosnippet>31</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#32 id=32 data-nosnippet>32</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#33 id=33 data-nosnippet>33</a> <span class="self">self</span>.inner.decode(input, output)
<a href=#34 id=34 data-nosnippet>34</a> }
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#37 id=37 data-nosnippet>37</a> <span class="self">self</span>.inner.flush(output)
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#41 id=41 data-nosnippet>41</a> <span class="self">self</span>.inner.finish(output)
<a href=#42 id=42 data-nosnippet>42</a> }
<a href=#43 id=43 data-nosnippet>43</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,39 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zlib/encoder.rs`."><title>encoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zlib/</div>encoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{flate::params::FlateEncoderParams, EncodeV2, FlateEncoder};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>compression_core::util::{PartialBuffer, WriteBuffer};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::io::Result;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="attr">#[derive(Debug)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>ZlibEncoder {
<a href=#7 id=7 data-nosnippet>7</a> inner: FlateEncoder,
<a href=#8 id=8 data-nosnippet>8</a>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>ZlibEncoder {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub fn </span>new(level: FlateEncoderParams) -&gt; <span class="self">Self </span>{
<a href=#12 id=12 data-nosnippet>12</a> <span class="self">Self </span>{
<a href=#13 id=13 data-nosnippet>13</a> inner: FlateEncoder::new(level, <span class="bool-val">true</span>),
<a href=#14 id=14 data-nosnippet>14</a> }
<a href=#15 id=15 data-nosnippet>15</a> }
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>FlateEncoder {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw-2">&amp;</span><span class="self">self</span>.inner
<a href=#19 id=19 data-nosnippet>19</a> }
<a href=#20 id=20 data-nosnippet>20</a>}
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">impl </span>EncodeV2 <span class="kw">for </span>ZlibEncoder {
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">fn </span>encode(
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#25 id=25 data-nosnippet>25</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#26 id=26 data-nosnippet>26</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#27 id=27 data-nosnippet>27</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#28 id=28 data-nosnippet>28</a> <span class="self">self</span>.inner.encode(input, output)
<a href=#29 id=29 data-nosnippet>29</a> }
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#32 id=32 data-nosnippet>32</a> <span class="self">self</span>.inner.flush(output)
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#36 id=36 data-nosnippet>36</a> <span class="self">self</span>.inner.finish(output)
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,5 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zlib/mod.rs`."><title>mod.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zlib/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-1"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>decoder;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">mod </span>encoder;
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">pub use </span><span class="self">self</span>::{decoder::ZlibDecoder, encoder::ZlibEncoder};
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,106 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zstd/decoder.rs`."><title>decoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zstd/</div>decoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{
<a href=#2 id=2 data-nosnippet>2</a> zstd::{params::DParameter, OperationExt},
<a href=#3 id=3 data-nosnippet>3</a> {DecodeV2, DecodedSize},
<a href=#4 id=4 data-nosnippet>4</a>};
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>compression_core::{
<a href=#6 id=6 data-nosnippet>6</a> unshared::Unshared,
<a href=#7 id=7 data-nosnippet>7</a> util::{PartialBuffer, WriteBuffer},
<a href=#8 id=8 data-nosnippet>8</a>};
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span>libzstd::stream::raw::Decoder;
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span>std::{
<a href=#11 id=11 data-nosnippet>11</a> convert::TryInto,
<a href=#12 id=12 data-nosnippet>12</a> io::{<span class="self">self</span>, <span class="prelude-ty">Result</span>},
<a href=#13 id=13 data-nosnippet>13</a>};
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">use </span>zstd_safe::get_error_name;
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a><span class="attr">#[derive(Debug)]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">pub struct </span>ZstdDecoder {
<a href=#18 id=18 data-nosnippet>18</a> decoder: Unshared&lt;Decoder&lt;<span class="lifetime">'static</span>&gt;&gt;,
<a href=#19 id=19 data-nosnippet>19</a> stream_ended: bool,
<a href=#20 id=20 data-nosnippet>20</a>}
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">impl </span>Default <span class="kw">for </span>ZstdDecoder {
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#24 id=24 data-nosnippet>24</a> <span class="self">Self </span>{
<a href=#25 id=25 data-nosnippet>25</a> decoder: Unshared::new(Decoder::new().unwrap()),
<a href=#26 id=26 data-nosnippet>26</a> stream_ended: <span class="bool-val">false</span>,
<a href=#27 id=27 data-nosnippet>27</a> }
<a href=#28 id=28 data-nosnippet>28</a> }
<a href=#29 id=29 data-nosnippet>29</a>}
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">impl </span>ZstdDecoder {
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<a href=#33 id=33 data-nosnippet>33</a> <span class="self">Self</span>::default()
<a href=#34 id=34 data-nosnippet>34</a> }
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">pub fn </span>new_with_params(params: <span class="kw-2">&amp;</span>[DParameter]) -&gt; <span class="self">Self </span>{
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span><span class="kw-2">mut </span>decoder = Decoder::new().unwrap();
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">for </span>param <span class="kw">in </span>params {
<a href=#39 id=39 data-nosnippet>39</a> decoder.set_parameter(param.as_zstd()).unwrap();
<a href=#40 id=40 data-nosnippet>40</a> }
<a href=#41 id=41 data-nosnippet>41</a> <span class="self">Self </span>{
<a href=#42 id=42 data-nosnippet>42</a> decoder: Unshared::new(decoder),
<a href=#43 id=43 data-nosnippet>43</a> stream_ended: <span class="bool-val">false</span>,
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">pub fn </span>new_with_dict(dictionary: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>decoder = Decoder::with_dictionary(dictionary)<span class="question-mark">?</span>;
<a href=#49 id=49 data-nosnippet>49</a> <span class="prelude-val">Ok</span>(<span class="self">Self </span>{
<a href=#50 id=50 data-nosnippet>50</a> decoder: Unshared::new(decoder),
<a href=#51 id=51 data-nosnippet>51</a> stream_ended: <span class="bool-val">false</span>,
<a href=#52 id=52 data-nosnippet>52</a> })
<a href=#53 id=53 data-nosnippet>53</a> }
<a href=#54 id=54 data-nosnippet>54</a>}
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a><span class="kw">impl </span>DecodeV2 <span class="kw">for </span>ZstdDecoder {
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#58 id=58 data-nosnippet>58</a> <span class="self">self</span>.decoder.reinit()<span class="question-mark">?</span>;
<a href=#59 id=59 data-nosnippet>59</a> <span class="self">self</span>.stream_ended = <span class="bool-val">false</span>;
<a href=#60 id=60 data-nosnippet>60</a> <span class="prelude-val">Ok</span>(())
<a href=#61 id=61 data-nosnippet>61</a> }
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">fn </span>decode(
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#65 id=65 data-nosnippet>65</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#66 id=66 data-nosnippet>66</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#67 id=67 data-nosnippet>67</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span>finished = <span class="self">self</span>.decoder.run(input, output)<span class="question-mark">?</span>;
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">if </span>finished {
<a href=#70 id=70 data-nosnippet>70</a> <span class="self">self</span>.stream_ended = <span class="bool-val">true</span>;
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a> <span class="prelude-val">Ok</span>(finished)
<a href=#73 id=73 data-nosnippet>73</a> }
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#76 id=76 data-nosnippet>76</a> <span class="comment">// Note: stream_ended is not updated here because zstd's flush only flushes
<a href=#77 id=77 data-nosnippet>77</a> // buffered output and doesn't indicate stream completion. Stream completion
<a href=#78 id=78 data-nosnippet>78</a> // is detected in decode() when status.remaining == 0.
<a href=#79 id=79 data-nosnippet>79</a> </span><span class="self">self</span>.decoder.flush(output)
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#83 id=83 data-nosnippet>83</a> <span class="self">self</span>.decoder.finish(output)<span class="question-mark">?</span>;
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if </span><span class="self">self</span>.stream_ended {
<a href=#86 id=86 data-nosnippet>86</a> <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>)
<a href=#87 id=87 data-nosnippet>87</a> } <span class="kw">else </span>{
<a href=#88 id=88 data-nosnippet>88</a> <span class="prelude-val">Err</span>(io::Error::new(
<a href=#89 id=89 data-nosnippet>89</a> io::ErrorKind::UnexpectedEof,
<a href=#90 id=90 data-nosnippet>90</a> <span class="string">"zstd stream did not finish"</span>,
<a href=#91 id=91 data-nosnippet>91</a> ))
<a href=#92 id=92 data-nosnippet>92</a> }
<a href=#93 id=93 data-nosnippet>93</a> }
<a href=#94 id=94 data-nosnippet>94</a>}
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a><span class="kw">impl </span>DecodedSize <span class="kw">for </span>ZstdDecoder {
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">fn </span>decoded_size(input: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;u64&gt; {
<a href=#98 id=98 data-nosnippet>98</a> zstd_safe::find_frame_compressed_size(input)
<a href=#99 id=99 data-nosnippet>99</a> .map_err(|error_code| io::Error::other(get_error_name(error_code)))
<a href=#100 id=100 data-nosnippet>100</a> .and_then(|size| {
<a href=#101 id=101 data-nosnippet>101</a> size.try_into()
<a href=#102 id=102 data-nosnippet>102</a> .map_err(|<span class="kw">_</span>| io::Error::from(io::ErrorKind::FileTooLarge))
<a href=#103 id=103 data-nosnippet>103</a> })
<a href=#104 id=104 data-nosnippet>104</a> }
<a href=#105 id=105 data-nosnippet>105</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,60 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zstd/encoder.rs`."><title>encoder.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zstd/</div>encoder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{
<a href=#2 id=2 data-nosnippet>2</a> zstd::{params::CParameter, OperationExt},
<a href=#3 id=3 data-nosnippet>3</a> EncodeV2,
<a href=#4 id=4 data-nosnippet>4</a>};
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>compression_core::{
<a href=#6 id=6 data-nosnippet>6</a> unshared::Unshared,
<a href=#7 id=7 data-nosnippet>7</a> util::{PartialBuffer, WriteBuffer},
<a href=#8 id=8 data-nosnippet>8</a>};
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span>libzstd::stream::raw::Encoder;
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span>std::io::{<span class="self">self</span>, <span class="prelude-ty">Result</span>};
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="attr">#[derive(Debug)]
<a href=#13 id=13 data-nosnippet>13</a></span><span class="kw">pub struct </span>ZstdEncoder {
<a href=#14 id=14 data-nosnippet>14</a> encoder: Unshared&lt;Encoder&lt;<span class="lifetime">'static</span>&gt;&gt;,
<a href=#15 id=15 data-nosnippet>15</a>}
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">impl </span>ZstdEncoder {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">pub fn </span>new(level: i32) -&gt; <span class="self">Self </span>{
<a href=#19 id=19 data-nosnippet>19</a> <span class="self">Self </span>{
<a href=#20 id=20 data-nosnippet>20</a> encoder: Unshared::new(Encoder::new(level).unwrap()),
<a href=#21 id=21 data-nosnippet>21</a> }
<a href=#22 id=22 data-nosnippet>22</a> }
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub fn </span>new_with_params(level: i32, params: <span class="kw-2">&amp;</span>[CParameter]) -&gt; <span class="self">Self </span>{
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">let </span><span class="kw-2">mut </span>encoder = Encoder::new(level).unwrap();
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">for </span>param <span class="kw">in </span>params {
<a href=#27 id=27 data-nosnippet>27</a> encoder.set_parameter(param.as_zstd()).unwrap();
<a href=#28 id=28 data-nosnippet>28</a> }
<a href=#29 id=29 data-nosnippet>29</a> <span class="self">Self </span>{
<a href=#30 id=30 data-nosnippet>30</a> encoder: Unshared::new(encoder),
<a href=#31 id=31 data-nosnippet>31</a> }
<a href=#32 id=32 data-nosnippet>32</a> }
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">pub fn </span>new_with_dict(level: i32, dictionary: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span>encoder = Encoder::with_dictionary(level, dictionary)<span class="question-mark">?</span>;
<a href=#36 id=36 data-nosnippet>36</a> <span class="prelude-val">Ok</span>(<span class="self">Self </span>{
<a href=#37 id=37 data-nosnippet>37</a> encoder: Unshared::new(encoder),
<a href=#38 id=38 data-nosnippet>38</a> })
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="kw">impl </span>EncodeV2 <span class="kw">for </span>ZstdEncoder {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">fn </span>encode(
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#45 id=45 data-nosnippet>45</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#46 id=46 data-nosnippet>46</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#47 id=47 data-nosnippet>47</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#48 id=48 data-nosnippet>48</a> <span class="self">self</span>.encoder.run(input, output)<span class="question-mark">?</span>;
<a href=#49 id=49 data-nosnippet>49</a> <span class="prelude-val">Ok</span>(())
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#53 id=53 data-nosnippet>53</a> <span class="self">self</span>.encoder.flush(output)
<a href=#54 id=54 data-nosnippet>54</a> }
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;bool&gt; {
<a href=#57 id=57 data-nosnippet>57</a> <span class="self">self</span>.encoder.finish(output)
<a href=#58 id=58 data-nosnippet>58</a> }
<a href=#59 id=59 data-nosnippet>59</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,98 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zstd/mod.rs`."><title>mod.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zstd/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>decoder;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">mod </span>encoder;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">pub mod </span>params;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub use </span><span class="self">self</span>::{decoder::ZstdDecoder, encoder::ZstdEncoder};
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>compression_core::{
<a href=#8 id=8 data-nosnippet>8</a> unshared::Unshared,
<a href=#9 id=9 data-nosnippet>9</a> util::{PartialBuffer, WriteBuffer},
<a href=#10 id=10 data-nosnippet>10</a>};
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>libzstd::stream::raw::{InBuffer, Operation, OutBuffer, WriteBuf};
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>std::io;
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="attr">#[repr(transparent)]
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">struct </span>WriteBufferWrapper&lt;<span class="lifetime">'a</span>&gt;(WriteBuffer&lt;<span class="lifetime">'a</span>&gt;);
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">unsafe impl </span>WriteBuf <span class="kw">for </span>WriteBufferWrapper&lt;<span class="lifetime">'_</span>&gt; {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">fn </span>as_slice(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<a href=#19 id=19 data-nosnippet>19</a> <span class="self">self</span>.<span class="number">0</span>.written()
<a href=#20 id=20 data-nosnippet>20</a> }
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">fn </span>capacity(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#22 id=22 data-nosnippet>22</a> <span class="self">self</span>.<span class="number">0</span>.capacity()
<a href=#23 id=23 data-nosnippet>23</a> }
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">fn </span>as_mut_ptr(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>u8 {
<a href=#25 id=25 data-nosnippet>25</a> <span class="self">self</span>.<span class="number">0</span>.as_mut_ptr()
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">unsafe fn </span>filled_until(<span class="kw-2">&amp;mut </span><span class="self">self</span>, n: usize) {
<a href=#28 id=28 data-nosnippet>28</a> <span class="self">self</span>.<span class="number">0</span>.set_written_and_initialized_len(n);
<a href=#29 id=29 data-nosnippet>29</a> }
<a href=#30 id=30 data-nosnippet>30</a>}
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">trait </span>WriteBufExt {
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">fn </span>get_out_buf(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; OutBuffer&lt;<span class="lifetime">'_</span>, WriteBufferWrapper&lt;<span class="lifetime">'_</span>&gt;&gt;;
<a href=#34 id=34 data-nosnippet>34</a>}
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="kw">impl </span>WriteBufExt <span class="kw">for </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt; {
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">fn </span>get_out_buf(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; OutBuffer&lt;<span class="lifetime">'_</span>, WriteBufferWrapper&lt;<span class="lifetime">'_</span>&gt;&gt; {
<a href=#38 id=38 data-nosnippet>38</a> {
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">use </span>std::mem::{align_of, size_of};
<a href=#40 id=40 data-nosnippet>40</a> <span class="macro">assert_eq!</span>(
<a href=#41 id=41 data-nosnippet>41</a> size_of::&lt;WriteBuffer&lt;<span class="lifetime">'static</span>&gt;&gt;(),
<a href=#42 id=42 data-nosnippet>42</a> size_of::&lt;WriteBufferWrapper&lt;<span class="lifetime">'static</span>&gt;&gt;()
<a href=#43 id=43 data-nosnippet>43</a> );
<a href=#44 id=44 data-nosnippet>44</a> <span class="macro">assert_eq!</span>(
<a href=#45 id=45 data-nosnippet>45</a> align_of::&lt;WriteBuffer&lt;<span class="lifetime">'static</span>&gt;&gt;(),
<a href=#46 id=46 data-nosnippet>46</a> align_of::&lt;WriteBufferWrapper&lt;<span class="lifetime">'static</span>&gt;&gt;()
<a href=#47 id=47 data-nosnippet>47</a> );
<a href=#48 id=48 data-nosnippet>48</a> }
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a> <span class="comment">// Pass written_len to avoid overwriting existing data in buffer.
<a href=#51 id=51 data-nosnippet>51</a> </span><span class="kw">let </span>written_len = <span class="self">self</span>.written_len();
<a href=#52 id=52 data-nosnippet>52</a> OutBuffer::around_pos(
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">unsafe </span>{ <span class="kw-2">&amp;mut *</span>(<span class="self">self </span><span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ as </span><span class="kw-2">*mut </span>WriteBufferWrapper&lt;<span class="lifetime">'_</span>&gt;) },
<a href=#54 id=54 data-nosnippet>54</a> written_len,
<a href=#55 id=55 data-nosnippet>55</a> )
<a href=#56 id=56 data-nosnippet>56</a> }
<a href=#57 id=57 data-nosnippet>57</a>}
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a><span class="kw">trait </span>OperationExt {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt;;
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="doccomment">/// Return `true` if finished.
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="kw">fn </span>run(
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#65 id=65 data-nosnippet>65</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#66 id=66 data-nosnippet>66</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#67 id=67 data-nosnippet>67</a> ) -&gt; io::Result&lt;bool&gt;;
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt;;
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt;;
<a href=#72 id=72 data-nosnippet>72</a>}
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a><span class="kw">impl</span>&lt;C: Operation&gt; OperationExt <span class="kw">for </span>Unshared&lt;C&gt; {
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">fn </span>reinit(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#76 id=76 data-nosnippet>76</a> <span class="self">self</span>.get_mut().reinit()
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">fn </span>run(
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#81 id=81 data-nosnippet>81</a> input: <span class="kw-2">&amp;mut </span>PartialBuffer&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
<a href=#82 id=82 data-nosnippet>82</a> output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;,
<a href=#83 id=83 data-nosnippet>83</a> ) -&gt; io::Result&lt;bool&gt; {
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span><span class="kw-2">mut </span>in_buf = InBuffer::around(input.unwritten());
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">let </span>result = <span class="self">self</span>.get_mut().run(<span class="kw-2">&amp;mut </span>in_buf, <span class="kw-2">&amp;mut </span>output.get_out_buf());
<a href=#86 id=86 data-nosnippet>86</a> input.advance(in_buf.pos());
<a href=#87 id=87 data-nosnippet>87</a> <span class="prelude-val">Ok</span>(result<span class="question-mark">? </span>== <span class="number">0</span>)
<a href=#88 id=88 data-nosnippet>88</a> }
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#91 id=91 data-nosnippet>91</a> <span class="prelude-val">Ok</span>(<span class="self">self</span>.get_mut().flush(<span class="kw-2">&amp;mut </span>output.get_out_buf())<span class="question-mark">? </span>== <span class="number">0</span>)
<a href=#92 id=92 data-nosnippet>92</a> }
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">fn </span>finish(<span class="kw-2">&amp;mut </span><span class="self">self</span>, output: <span class="kw-2">&amp;mut </span>WriteBuffer&lt;<span class="lifetime">'_</span>&gt;) -&gt; io::Result&lt;bool&gt; {
<a href=#95 id=95 data-nosnippet>95</a> <span class="prelude-val">Ok</span>(<span class="self">self</span>.get_mut().finish(<span class="kw-2">&amp;mut </span>output.get_out_buf(), <span class="bool-val">true</span>)<span class="question-mark">? </span>== <span class="number">0</span>)
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,155 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/compression-codecs-0.4.37/src/zstd/params.rs`."><title>params.rs - source</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="compression_codecs" 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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">compression_codecs/zstd/</div>params.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! This module contains zstd-specific types for async-compression.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>compression_core::Level;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// A compression parameter for zstd. This is a stable wrapper around zstd's own `CParameter`
<a href=#6 id=6 data-nosnippet>6</a>/// type, to abstract over different versions of the zstd library.
<a href=#7 id=7 data-nosnippet>7</a>///
<a href=#8 id=8 data-nosnippet>8</a>/// See the [zstd documentation](https://facebook.github.io/zstd/zstd_manual.html) for more
<a href=#9 id=9 data-nosnippet>9</a>/// information on these parameters.
<a href=#10 id=10 data-nosnippet>10</a></span><span class="attr">#[derive(Copy, Clone, Debug, PartialEq, Eq)]
<a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">pub struct </span>CParameter(libzstd::stream::raw::CParameter);
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">impl </span>From&lt;CParameter&gt; <span class="kw">for </span>libzstd::stream::raw::CParameter {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">fn </span>from(value: CParameter) -&gt; <span class="self">Self </span>{
<a href=#15 id=15 data-nosnippet>15</a> value.<span class="number">0
<a href=#16 id=16 data-nosnippet>16</a> </span>}
<a href=#17 id=17 data-nosnippet>17</a>}
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">impl </span>CParameter {
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub fn </span>quality(level: Level) -&gt; i32 {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">let </span>(fastest, best) = libzstd::compression_level_range().into_inner();
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a> <span class="comment">// NOTE: zstd's "fastest" level is -131072 which can create outputs larger than inputs.
<a href=#24 id=24 data-nosnippet>24</a> // This library chooses a "fastest" level which has a more-or-less equivalent compression
<a href=#25 id=25 data-nosnippet>25</a> // ratio to gzip's fastest mode. We still allow precise levels to go negative.
<a href=#26 id=26 data-nosnippet>26</a> // See discussion in https://github.com/Nullus157/async-compression/issues/352
<a href=#27 id=27 data-nosnippet>27</a> </span><span class="kw">const </span>OUR_FASTEST: i32 = <span class="number">1</span>;
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">match </span>level {
<a href=#30 id=30 data-nosnippet>30</a> Level::Fastest =&gt; OUR_FASTEST,
<a href=#31 id=31 data-nosnippet>31</a> Level::Best =&gt; best,
<a href=#32 id=32 data-nosnippet>32</a> Level::Precise(quality) =&gt; quality.clamp(fastest, best),
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">_ </span>=&gt; libzstd::DEFAULT_COMPRESSION_LEVEL,
<a href=#34 id=34 data-nosnippet>34</a> }
<a href=#35 id=35 data-nosnippet>35</a> }
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a> <span class="doccomment">/// Window size in bytes (as a power of two)
<a href=#38 id=38 data-nosnippet>38</a> </span><span class="kw">pub fn </span>window_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#39 id=39 data-nosnippet>39</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::WindowLog(value))
<a href=#40 id=40 data-nosnippet>40</a> }
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// Size of the initial probe table in 4-byte entries (as a power of two)
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">pub fn </span>hash_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#44 id=44 data-nosnippet>44</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::HashLog(value))
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="doccomment">/// Size of the multi-probe table in 4-byte entries (as a power of two)
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub fn </span>chain_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#49 id=49 data-nosnippet>49</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::ChainLog(value))
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Number of search attempts (as a power of two)
<a href=#53 id=53 data-nosnippet>53</a> </span><span class="kw">pub fn </span>search_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#54 id=54 data-nosnippet>54</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::SearchLog(value))
<a href=#55 id=55 data-nosnippet>55</a> }
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a> <span class="doccomment">/// Minimum size of matches searched for
<a href=#58 id=58 data-nosnippet>58</a> </span><span class="kw">pub fn </span>min_match(value: u32) -&gt; <span class="self">Self </span>{
<a href=#59 id=59 data-nosnippet>59</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::MinMatch(value))
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="doccomment">/// Strategy-dependent length modifier
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="kw">pub fn </span>target_length(value: u32) -&gt; <span class="self">Self </span>{
<a href=#64 id=64 data-nosnippet>64</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::TargetLength(value))
<a href=#65 id=65 data-nosnippet>65</a> }
<a href=#66 id=66 data-nosnippet>66</a>
<a href=#67 id=67 data-nosnippet>67</a> <span class="doccomment">/// Enable long-distance matching mode to look for and emit long-distance references.
<a href=#68 id=68 data-nosnippet>68</a> ///
<a href=#69 id=69 data-nosnippet>69</a> /// This increases the default window size.
<a href=#70 id=70 data-nosnippet>70</a> </span><span class="kw">pub fn </span>enable_long_distance_matching(value: bool) -&gt; <span class="self">Self </span>{
<a href=#71 id=71 data-nosnippet>71</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::EnableLongDistanceMatching(value))
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="doccomment">/// Size of the long-distance matching table (as a power of two)
<a href=#75 id=75 data-nosnippet>75</a> </span><span class="kw">pub fn </span>ldm_hash_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#76 id=76 data-nosnippet>76</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::LdmHashLog(value))
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="doccomment">/// Minimum size of long-distance matches searched for
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub fn </span>ldm_min_match(value: u32) -&gt; <span class="self">Self </span>{
<a href=#81 id=81 data-nosnippet>81</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::LdmMinMatch(value))
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a> <span class="doccomment">/// Size of each bucket in the LDM hash table for collision resolution (as a power of two)
<a href=#85 id=85 data-nosnippet>85</a> </span><span class="kw">pub fn </span>ldm_bucket_size_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#86 id=86 data-nosnippet>86</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::LdmBucketSizeLog(value))
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="doccomment">/// Frequency of using the LDM hash table (as a power of two)
<a href=#90 id=90 data-nosnippet>90</a> </span><span class="kw">pub fn </span>ldm_hash_rate_log(value: u32) -&gt; <span class="self">Self </span>{
<a href=#91 id=91 data-nosnippet>91</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::LdmHashRateLog(value))
<a href=#92 id=92 data-nosnippet>92</a> }
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a> <span class="doccomment">/// Emit the size of the content (default: true).
<a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">pub fn </span>content_size_flag(value: bool) -&gt; <span class="self">Self </span>{
<a href=#96 id=96 data-nosnippet>96</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::ContentSizeFlag(value))
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> <span class="doccomment">/// Emit a checksum (default: false).
<a href=#100 id=100 data-nosnippet>100</a> </span><span class="kw">pub fn </span>checksum_flag(value: bool) -&gt; <span class="self">Self </span>{
<a href=#101 id=101 data-nosnippet>101</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::ChecksumFlag(value))
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> <span class="doccomment">/// Emit a dictionary ID when using a custom dictionary (default: true).
<a href=#105 id=105 data-nosnippet>105</a> </span><span class="kw">pub fn </span>dict_id_flag(value: bool) -&gt; <span class="self">Self </span>{
<a href=#106 id=106 data-nosnippet>106</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::DictIdFlag(value))
<a href=#107 id=107 data-nosnippet>107</a> }
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a> <span class="doccomment">/// Number of threads to spawn.
<a href=#110 id=110 data-nosnippet>110</a> ///
<a href=#111 id=111 data-nosnippet>111</a> /// If set to 0, compression functions will block; if set to 1 or more, compression will
<a href=#112 id=112 data-nosnippet>112</a> /// run in background threads and `flush` pushes bytes through the compressor.
<a href=#113 id=113 data-nosnippet>113</a> ///
<a href=#114 id=114 data-nosnippet>114</a> /// # Panics
<a href=#115 id=115 data-nosnippet>115</a> ///
<a href=#116 id=116 data-nosnippet>116</a> /// This parameter requires feature `zstdmt` to be enabled, otherwise it will cause a panic
<a href=#117 id=117 data-nosnippet>117</a> /// when used in `ZstdEncoder::with_quality_and_params()` calls.
<a href=#118 id=118 data-nosnippet>118</a> </span><span class="comment">//
<a href=#119 id=119 data-nosnippet>119</a> // TODO: make this a normal feature guarded fn on next breaking release
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="attr">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"zstdmt"</span>)))]
<a href=#121 id=121 data-nosnippet>121</a> </span><span class="kw">pub fn </span>nb_workers(value: u32) -&gt; <span class="self">Self </span>{
<a href=#122 id=122 data-nosnippet>122</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::NbWorkers(value))
<a href=#123 id=123 data-nosnippet>123</a> }
<a href=#124 id=124 data-nosnippet>124</a>
<a href=#125 id=125 data-nosnippet>125</a> <span class="doccomment">/// Number of bytes given to each worker.
<a href=#126 id=126 data-nosnippet>126</a> ///
<a href=#127 id=127 data-nosnippet>127</a> /// If set to 0, zstd selects a job size based on compression parameters.
<a href=#128 id=128 data-nosnippet>128</a> </span><span class="kw">pub fn </span>job_size(value: u32) -&gt; <span class="self">Self </span>{
<a href=#129 id=129 data-nosnippet>129</a> <span class="self">Self</span>(libzstd::stream::raw::CParameter::JobSize(value))
<a href=#130 id=130 data-nosnippet>130</a> }
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_zstd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; libzstd::stream::raw::CParameter {
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">self</span>.<span class="number">0
<a href=#134 id=134 data-nosnippet>134</a> </span>}
<a href=#135 id=135 data-nosnippet>135</a>}
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a><span class="doccomment">/// A decompression parameter for zstd. This is a stable wrapper around zstd's own `DParameter`
<a href=#138 id=138 data-nosnippet>138</a>/// type, to abstract over different versions of the zstd library.
<a href=#139 id=139 data-nosnippet>139</a>///
<a href=#140 id=140 data-nosnippet>140</a>/// See the [zstd documentation](https://facebook.github.io/zstd/zstd_manual.html) for more
<a href=#141 id=141 data-nosnippet>141</a>/// information on these parameters.
<a href=#142 id=142 data-nosnippet>142</a></span><span class="attr">#[derive(Copy, Clone, Debug, PartialEq, Eq)]
<a href=#143 id=143 data-nosnippet>143</a></span><span class="kw">pub struct </span>DParameter(libzstd::stream::raw::DParameter);
<a href=#144 id=144 data-nosnippet>144</a>
<a href=#145 id=145 data-nosnippet>145</a><span class="kw">impl </span>DParameter {
<a href=#146 id=146 data-nosnippet>146</a> <span class="doccomment">/// Maximum window size in bytes (as a power of two)
<a href=#147 id=147 data-nosnippet>147</a> </span><span class="kw">pub fn </span>window_log_max(value: u32) -&gt; <span class="self">Self </span>{
<a href=#148 id=148 data-nosnippet>148</a> <span class="self">Self</span>(libzstd::stream::raw::DParameter::WindowLogMax(value))
<a href=#149 id=149 data-nosnippet>149</a> }
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_zstd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; libzstd::stream::raw::DParameter {
<a href=#152 id=152 data-nosnippet>152</a> <span class="self">self</span>.<span class="number">0
<a href=#153 id=153 data-nosnippet>153</a> </span>}
<a href=#154 id=154 data-nosnippet>154</a>}
</code></pre></div></section></main></body></html>