190 lines
20 KiB
HTML
190 lines
20 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/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<[u8; <span class="number">10</span>]>),
|
|
<a href=#22 id=22 data-nosnippet>22</a> ExtraLen(PartialBuffer<[u8; <span class="number">2</span>]>),
|
|
<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<[u8; <span class="number">2</span>]>),
|
|
<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() -> <span class="self">Self </span>{
|
|
<a href=#32 id=32 data-nosnippet>32</a> State::Fixed(<<span class="kw">_</span>>::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">&</span>[u8; <span class="number">10</span>]) -> io::Result<<span class="self">Self</span>> {
|
|
<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 & <span class="number">0b0000_0001</span>) != <span class="number">0</span>,
|
|
<a href=#55 id=55 data-nosnippet>55</a> crc: (flag & <span class="number">0b0000_0010</span>) != <span class="number">0</span>,
|
|
<a href=#56 id=56 data-nosnippet>56</a> extra: (flag & <span class="number">0b0000_0100</span>) != <span class="number">0</span>,
|
|
<a href=#57 id=57 data-nosnippet>57</a> filename: (flag & <span class="number">0b0000_1000</span>) != <span class="number">0</span>,
|
|
<a href=#58 id=58 data-nosnippet>58</a> comment: (flag & <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">&mut </span>Crc, n: usize, input: <span class="kw-2">&mut </span>PartialBuffer<<span class="kw-2">&</span>[u8]>) {
|
|
<a href=#66 id=66 data-nosnippet>66</a> crc.update(<span class="kw-2">&</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">&mut </span>Crc, input: <span class="kw-2">&mut </span>PartialBuffer<<span class="kw-2">&</span>[u8]>) -> <span class="prelude-ty">Option</span><()> {
|
|
<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">&mut </span><span class="self">self</span>,
|
|
<a href=#83 id=83 data-nosnippet>83</a> crc: <span class="kw-2">&mut </span>Crc,
|
|
<a href=#84 id=84 data-nosnippet>84</a> input: <span class="kw-2">&mut </span>PartialBuffer<<span class="kw-2">&</span>[u8]>,
|
|
<a href=#85 id=85 data-nosnippet>85</a> ) -> io::Result<<span class="prelude-ty">Option</span><Header>> {
|
|
<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">&mut </span><span class="self">self</span>.state {
|
|
<a href=#88 id=88 data-nosnippet>88</a> State::Fixed(data) => {
|
|
<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(<<span class="kw">_</span>>::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) => {
|
|
<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) => {
|
|
<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 => {
|
|
<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 => {
|
|
<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(<<span class="kw">_</span>>::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(<<span class="kw">_</span>>::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) => {
|
|
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">let </span>header = std::mem::take(<span class="kw-2">&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 => <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> |