165 lines
17 KiB
HTML
165 lines
17 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/zstd-0.13.3/src/bulk/compressor.rs`."><title>compressor.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="zstd" 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">zstd/bulk/</div>compressor.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>::map_error_code;
|
|
<a href=#2 id=2 data-nosnippet>2</a>
|
|
<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><span class="kw">use </span>zstd_safe;
|
|
<a href=#5 id=5 data-nosnippet>5</a>
|
|
<a href=#6 id=6 data-nosnippet>6</a><span class="doccomment">/// Allows to compress independently multiple chunks of data.
|
|
<a href=#7 id=7 data-nosnippet>7</a>///
|
|
<a href=#8 id=8 data-nosnippet>8</a>/// Each job will be processed entirely in-memory without streaming, so this
|
|
<a href=#9 id=9 data-nosnippet>9</a>/// is most fitting for many small jobs. To compress larger volume that don't
|
|
<a href=#10 id=10 data-nosnippet>10</a>/// easily fit in memory, a streaming compression may be more appropriate.
|
|
<a href=#11 id=11 data-nosnippet>11</a>///
|
|
<a href=#12 id=12 data-nosnippet>12</a>/// It is more efficient than a streaming compressor for 2 reasons:
|
|
<a href=#13 id=13 data-nosnippet>13</a>/// * It re-uses the zstd context between jobs to avoid re-allocations
|
|
<a href=#14 id=14 data-nosnippet>14</a>/// * It avoids copying data from a `Read` into a temporary buffer before compression.
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="attr">#[derive(Default)]
|
|
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">pub struct </span>Compressor<<span class="lifetime">'a</span>> {
|
|
<a href=#17 id=17 data-nosnippet>17</a> context: zstd_safe::CCtx<<span class="lifetime">'a</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><span class="kw">impl </span>Compressor<<span class="lifetime">'static</span>> {
|
|
<a href=#21 id=21 data-nosnippet>21</a> <span class="doccomment">/// Creates a new zstd compressor
|
|
<a href=#22 id=22 data-nosnippet>22</a> </span><span class="kw">pub fn </span>new(level: i32) -> io::Result<<span class="self">Self</span>> {
|
|
<a href=#23 id=23 data-nosnippet>23</a> <span class="self">Self</span>::with_dictionary(level, <span class="kw-2">&</span>[])
|
|
<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="doccomment">/// Creates a new zstd compressor, using the given dictionary.
|
|
<a href=#27 id=27 data-nosnippet>27</a> ///
|
|
<a href=#28 id=28 data-nosnippet>28</a> /// Note that using a dictionary means that decompression will need to use
|
|
<a href=#29 id=29 data-nosnippet>29</a> /// the same dictionary.
|
|
<a href=#30 id=30 data-nosnippet>30</a> </span><span class="kw">pub fn </span>with_dictionary(level: i32, dictionary: <span class="kw-2">&</span>[u8]) -> io::Result<<span class="self">Self</span>> {
|
|
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">let </span><span class="kw-2">mut </span>compressor = <span class="self">Self</span>::default();
|
|
<a href=#32 id=32 data-nosnippet>32</a>
|
|
<a href=#33 id=33 data-nosnippet>33</a> compressor.set_dictionary(level, dictionary)<span class="question-mark">?</span>;
|
|
<a href=#34 id=34 data-nosnippet>34</a>
|
|
<a href=#35 id=35 data-nosnippet>35</a> <span class="prelude-val">Ok</span>(compressor)
|
|
<a href=#36 id=36 data-nosnippet>36</a> }
|
|
<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><span class="kw">impl</span><<span class="lifetime">'a</span>> Compressor<<span class="lifetime">'a</span>> {
|
|
<a href=#40 id=40 data-nosnippet>40</a> <span class="doccomment">/// Creates a new compressor using an existing `EncoderDictionary`.
|
|
<a href=#41 id=41 data-nosnippet>41</a> ///
|
|
<a href=#42 id=42 data-nosnippet>42</a> /// The compression level will be the one specified when creating the dictionary.
|
|
<a href=#43 id=43 data-nosnippet>43</a> ///
|
|
<a href=#44 id=44 data-nosnippet>44</a> /// Note that using a dictionary means that decompression will need to use
|
|
<a href=#45 id=45 data-nosnippet>45</a> /// the same dictionary.
|
|
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="kw">pub fn </span>with_prepared_dictionary<<span class="lifetime">'b</span>>(
|
|
<a href=#47 id=47 data-nosnippet>47</a> dictionary: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw">crate</span>::dict::EncoderDictionary<<span class="lifetime">'b</span>>,
|
|
<a href=#48 id=48 data-nosnippet>48</a> ) -> io::Result<<span class="self">Self</span>>
|
|
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">where
|
|
<a href=#50 id=50 data-nosnippet>50</a> </span><span class="lifetime">'b</span>: <span class="lifetime">'a</span>,
|
|
<a href=#51 id=51 data-nosnippet>51</a> {
|
|
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span><span class="kw-2">mut </span>compressor = <span class="self">Self</span>::default();
|
|
<a href=#53 id=53 data-nosnippet>53</a>
|
|
<a href=#54 id=54 data-nosnippet>54</a> compressor.set_prepared_dictionary(dictionary)<span class="question-mark">?</span>;
|
|
<a href=#55 id=55 data-nosnippet>55</a>
|
|
<a href=#56 id=56 data-nosnippet>56</a> <span class="prelude-val">Ok</span>(compressor)
|
|
<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="doccomment">/// Changes the compression level used by this compressor.
|
|
<a href=#60 id=60 data-nosnippet>60</a> ///
|
|
<a href=#61 id=61 data-nosnippet>61</a> /// *This will clear any dictionary previously registered.*
|
|
<a href=#62 id=62 data-nosnippet>62</a> ///
|
|
<a href=#63 id=63 data-nosnippet>63</a> /// If you want to keep the existing dictionary, you will need to pass it again to
|
|
<a href=#64 id=64 data-nosnippet>64</a> /// `Self::set_dictionary` instead of using this method.
|
|
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">pub fn </span>set_compression_level(<span class="kw-2">&mut </span><span class="self">self</span>, level: i32) -> io::Result<()> {
|
|
<a href=#66 id=66 data-nosnippet>66</a> <span class="self">self</span>.set_dictionary(level, <span class="kw-2">&</span>[])
|
|
<a href=#67 id=67 data-nosnippet>67</a> }
|
|
<a href=#68 id=68 data-nosnippet>68</a>
|
|
<a href=#69 id=69 data-nosnippet>69</a> <span class="doccomment">/// Changes the dictionary and compression level used by this compressor.
|
|
<a href=#70 id=70 data-nosnippet>70</a> ///
|
|
<a href=#71 id=71 data-nosnippet>71</a> /// Will affect future compression jobs.
|
|
<a href=#72 id=72 data-nosnippet>72</a> ///
|
|
<a href=#73 id=73 data-nosnippet>73</a> /// Note that using a dictionary means that decompression will need to use
|
|
<a href=#74 id=74 data-nosnippet>74</a> /// the same dictionary.
|
|
<a href=#75 id=75 data-nosnippet>75</a> </span><span class="kw">pub fn </span>set_dictionary(
|
|
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw-2">&mut </span><span class="self">self</span>,
|
|
<a href=#77 id=77 data-nosnippet>77</a> level: i32,
|
|
<a href=#78 id=78 data-nosnippet>78</a> dictionary: <span class="kw-2">&</span>[u8],
|
|
<a href=#79 id=79 data-nosnippet>79</a> ) -> io::Result<()> {
|
|
<a href=#80 id=80 data-nosnippet>80</a> <span class="self">self</span>.context
|
|
<a href=#81 id=81 data-nosnippet>81</a> .set_parameter(zstd_safe::CParameter::CompressionLevel(level))
|
|
<a href=#82 id=82 data-nosnippet>82</a> .map_err(map_error_code)<span class="question-mark">?</span>;
|
|
<a href=#83 id=83 data-nosnippet>83</a>
|
|
<a href=#84 id=84 data-nosnippet>84</a> <span class="self">self</span>.context
|
|
<a href=#85 id=85 data-nosnippet>85</a> .load_dictionary(dictionary)
|
|
<a href=#86 id=86 data-nosnippet>86</a> .map_err(map_error_code)<span class="question-mark">?</span>;
|
|
<a href=#87 id=87 data-nosnippet>87</a>
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="prelude-val">Ok</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> <span class="doccomment">/// Changes the dictionary used by this compressor.
|
|
<a href=#92 id=92 data-nosnippet>92</a> ///
|
|
<a href=#93 id=93 data-nosnippet>93</a> /// The compression level used when preparing the dictionary will be used.
|
|
<a href=#94 id=94 data-nosnippet>94</a> ///
|
|
<a href=#95 id=95 data-nosnippet>95</a> /// Note that using a dictionary means that decompression will need to use
|
|
<a href=#96 id=96 data-nosnippet>96</a> /// the same dictionary.
|
|
<a href=#97 id=97 data-nosnippet>97</a> </span><span class="kw">pub fn </span>set_prepared_dictionary<<span class="lifetime">'b</span>>(
|
|
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw-2">&mut </span><span class="self">self</span>,
|
|
<a href=#99 id=99 data-nosnippet>99</a> dictionary: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw">crate</span>::dict::EncoderDictionary<<span class="lifetime">'b</span>>,
|
|
<a href=#100 id=100 data-nosnippet>100</a> ) -> io::Result<()>
|
|
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">where
|
|
<a href=#102 id=102 data-nosnippet>102</a> </span><span class="lifetime">'b</span>: <span class="lifetime">'a</span>,
|
|
<a href=#103 id=103 data-nosnippet>103</a> {
|
|
<a href=#104 id=104 data-nosnippet>104</a> <span class="self">self</span>.context
|
|
<a href=#105 id=105 data-nosnippet>105</a> .ref_cdict(dictionary.as_cdict())
|
|
<a href=#106 id=106 data-nosnippet>106</a> .map_err(map_error_code)<span class="question-mark">?</span>;
|
|
<a href=#107 id=107 data-nosnippet>107</a>
|
|
<a href=#108 id=108 data-nosnippet>108</a> <span class="prelude-val">Ok</span>(())
|
|
<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> <span class="doccomment">/// Compress a single block of data to the given destination buffer.
|
|
<a href=#112 id=112 data-nosnippet>112</a> ///
|
|
<a href=#113 id=113 data-nosnippet>113</a> /// Returns the number of bytes written, or an error if something happened
|
|
<a href=#114 id=114 data-nosnippet>114</a> /// (for instance if the destination buffer was too small).
|
|
<a href=#115 id=115 data-nosnippet>115</a> ///
|
|
<a href=#116 id=116 data-nosnippet>116</a> /// A level of `0` uses zstd's default (currently `3`).
|
|
<a href=#117 id=117 data-nosnippet>117</a> </span><span class="kw">pub fn </span>compress_to_buffer<C: zstd_safe::WriteBuf + <span class="question-mark">?</span>Sized>(
|
|
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw-2">&mut </span><span class="self">self</span>,
|
|
<a href=#119 id=119 data-nosnippet>119</a> source: <span class="kw-2">&</span>[u8],
|
|
<a href=#120 id=120 data-nosnippet>120</a> destination: <span class="kw-2">&mut </span>C,
|
|
<a href=#121 id=121 data-nosnippet>121</a> ) -> io::Result<usize> {
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="self">self</span>.context
|
|
<a href=#123 id=123 data-nosnippet>123</a> .compress2(destination, source)
|
|
<a href=#124 id=124 data-nosnippet>124</a> .map_err(map_error_code)
|
|
<a href=#125 id=125 data-nosnippet>125</a> }
|
|
<a href=#126 id=126 data-nosnippet>126</a>
|
|
<a href=#127 id=127 data-nosnippet>127</a> <span class="doccomment">/// Compresses a block of data and returns the compressed result.
|
|
<a href=#128 id=128 data-nosnippet>128</a> ///
|
|
<a href=#129 id=129 data-nosnippet>129</a> /// A level of `0` uses zstd's default (currently `3`).
|
|
<a href=#130 id=130 data-nosnippet>130</a> </span><span class="kw">pub fn </span>compress(<span class="kw-2">&mut </span><span class="self">self</span>, data: <span class="kw-2">&</span>[u8]) -> io::Result<Vec<u8>> {
|
|
<a href=#131 id=131 data-nosnippet>131</a> <span class="comment">// We allocate a big buffer, slightly larger than the input data.
|
|
<a href=#132 id=132 data-nosnippet>132</a> </span><span class="kw">let </span>buffer_len = zstd_safe::compress_bound(data.len());
|
|
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::with_capacity(buffer_len);
|
|
<a href=#134 id=134 data-nosnippet>134</a>
|
|
<a href=#135 id=135 data-nosnippet>135</a> <span class="self">self</span>.compress_to_buffer(data, <span class="kw-2">&mut </span>buffer)<span class="question-mark">?</span>;
|
|
<a href=#136 id=136 data-nosnippet>136</a>
|
|
<a href=#137 id=137 data-nosnippet>137</a> <span class="comment">// Should we shrink the vec? Meh, let the user do it if he wants.
|
|
<a href=#138 id=138 data-nosnippet>138</a> </span><span class="prelude-val">Ok</span>(buffer)
|
|
<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="doccomment">/// Gives mutable access to the internal context.
|
|
<a href=#142 id=142 data-nosnippet>142</a> </span><span class="kw">pub fn </span>context_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>zstd_safe::CCtx<<span class="lifetime">'a</span>> {
|
|
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw-2">&mut </span><span class="self">self</span>.context
|
|
<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="doccomment">/// Sets a compression parameter for this compressor.
|
|
<a href=#147 id=147 data-nosnippet>147</a> </span><span class="kw">pub fn </span>set_parameter(
|
|
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw-2">&mut </span><span class="self">self</span>,
|
|
<a href=#149 id=149 data-nosnippet>149</a> parameter: zstd_safe::CParameter,
|
|
<a href=#150 id=150 data-nosnippet>150</a> ) -> io::Result<()> {
|
|
<a href=#151 id=151 data-nosnippet>151</a> <span class="self">self</span>.context
|
|
<a href=#152 id=152 data-nosnippet>152</a> .set_parameter(parameter)
|
|
<a href=#153 id=153 data-nosnippet>153</a> .map_err(map_error_code)<span class="question-mark">?</span>;
|
|
<a href=#154 id=154 data-nosnippet>154</a> <span class="prelude-val">Ok</span>(())
|
|
<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> <span class="macro">crate::encoder_parameters!</span>();
|
|
<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><span class="kw">fn </span>_assert_traits() {
|
|
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">fn </span>_assert_send<T: Send>(<span class="kw">_</span>: T) {}
|
|
<a href=#162 id=162 data-nosnippet>162</a>
|
|
<a href=#163 id=163 data-nosnippet>163</a> _assert_send(Compressor::new(<span class="number">0</span>));
|
|
<a href=#164 id=164 data-nosnippet>164</a>}
|
|
</code></pre></div></section></main></body></html> |