jubako 0.3.0

The reference implementation of the Jubako container format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

use std::borrow::Cow;

use zerocopy::{ByteOrder, LE};

use super::{Offset, Result};

use super::ByteSize;

/// A Parser is something parsing data from a [u8]
pub trait Parser {
    fn read_slice(&mut self, size: usize) -> Result<Cow<[u8]>>;
    fn read_data(&mut self, buf: &mut [u8]) -> Result<()>;
    #[cfg(test)]
    fn tell(&self) -> Offset;
    fn global_offset(&self) -> Offset;
    fn skip(&mut self, size: usize) -> Result<()>;

    fn read_u8(&mut self) -> Result<u8> {
        let slice = self.read_slice(1)?;
        Ok(slice[0])
    }

    fn read_u16(&mut self) -> Result<u16> {
        let slice = self.read_slice(2)?;
        Ok(LE::read_u16(&slice))
    }

    fn read_u32(&mut self) -> Result<u32> {
        let slice = self.read_slice(4)?;
        Ok(LE::read_u32(&slice))
    }

    fn read_u64(&mut self) -> Result<u64> {
        let slice = self.read_slice(8)?;
        Ok(LE::read_u64(&slice))
    }

    fn read_usized(&mut self, size: ByteSize) -> Result<u64> {
        let size = size as usize;
        let slice = self.read_slice(size)?;
        Ok(LE::read_uint(&slice, size))
    }

    fn read_isized(&mut self, size: ByteSize) -> Result<i64> {
        let size = size as usize;
        let slice = self.read_slice(size)?;
        Ok(LE::read_int(&slice, size))
    }
}

/// A RandomParser is something parsing data from a [u8] at random position
pub trait RandomParser {
    type Parser<'a>: Parser
    where
        Self: 'a;

    fn create_parser(&self, offset: Offset) -> Result<Self::Parser<'_>>;
    fn read_slice(&self, offset: Offset, size: usize) -> Result<Cow<[u8]>>;
    fn read_data(&self, offset: Offset, buf: &mut [u8]) -> Result<()>;

    fn global_offset(&self) -> Offset;
    fn read_u8(&self, offset: Offset) -> Result<u8> {
        let slice = self.read_slice(offset, 1)?;
        Ok(slice[0])
    }

    fn read_u16(&self, offset: Offset) -> Result<u16> {
        let slice = self.read_slice(offset, 2)?;
        Ok(LE::read_u16(&slice))
    }

    fn read_u32(&self, offset: Offset) -> Result<u32> {
        let slice = self.read_slice(offset, 4)?;
        Ok(LE::read_u32(&slice))
    }

    fn read_u64(&self, offset: Offset) -> Result<u64> {
        let slice = self.read_slice(offset, 8)?;
        Ok(LE::read_u64(&slice))
    }

    fn read_usized(&self, offset: Offset, size: ByteSize) -> Result<u64> {
        let size = size as usize;
        let slice = self.read_slice(offset, size)?;
        Ok(LE::read_uint(&slice, size))
    }

    fn read_i8(&self, offset: Offset) -> Result<i8> {
        let slice = self.read_slice(offset, 1)?;
        Ok(slice[0] as i8)
    }

    fn read_i16(&self, offset: Offset) -> Result<i16> {
        let slice = self.read_slice(offset, 2)?;
        Ok(LE::read_i16(&slice))
    }

    fn read_i32(&self, offset: Offset) -> Result<i32> {
        let slice = self.read_slice(offset, 4)?;
        Ok(LE::read_i32(&slice))
    }

    fn read_i64(&self, offset: Offset) -> Result<i64> {
        let slice = self.read_slice(offset, 8)?;
        Ok(LE::read_i64(&slice))
    }

    fn read_isized(&self, offset: Offset, size: ByteSize) -> Result<i64> {
        let size = size as usize;
        let slice = self.read_slice(offset, size)?;
        Ok(LE::read_int(&slice, size))
    }
}

pub struct SliceParser<'a> {
    slice: Cow<'a, [u8]>,
    global_offset: Offset,
    offset: usize,
}

impl<'a> SliceParser<'a> {
    pub(crate) fn new(slice: Cow<'a, [u8]>, global_offset: Offset) -> Self {
        Self {
            slice,
            global_offset,
            offset: 0,
        }
    }
}

impl<'a> Parser for SliceParser<'a> {
    fn read_slice(&mut self, size: usize) -> Result<Cow<[u8]>> {
        if self.slice.len() < size + self.offset {
            return Err(format!(
                "Out of slice. {size}({}) > {}",
                self.offset,
                self.slice.len()
            )
            .into());
        }
        let slice = &self.slice[self.offset..self.offset + size];
        self.offset += size;
        Ok(Cow::Borrowed(slice))
    }

    fn read_data(&mut self, buf: &mut [u8]) -> Result<()> {
        if self.slice.len() < buf.len() + self.offset {
            return Err(format!(
                "Out of slice. {}({}) > {}",
                buf.len(),
                self.offset,
                self.slice.len()
            )
            .into());
        }
        buf.copy_from_slice(&self.slice[self.offset..self.offset + buf.len()]);
        self.offset += buf.len();
        Ok(())
    }

    fn skip(&mut self, size: usize) -> Result<()> {
        if self.slice.len() < size + self.offset {
            return Err(format!(
                "Out of slice. {size}({}) > {}",
                self.offset,
                self.slice.len()
            )
            .into());
        }
        self.offset += size;
        Ok(())
    }

    #[cfg(test)]
    fn tell(&self) -> Offset {
        self.offset.into()
    }

    fn global_offset(&self) -> Offset {
        self.global_offset + self.offset
    }
}

/// A Producable is a object that can be produce from a parser.
pub trait Parsable {
    type Output;
    fn parse(parser: &mut impl Parser) -> Result<Self::Output>
    where
        Self::Output: Sized;
}

pub(crate) trait SizedParsable: Parsable {
    const SIZE: usize;
}

impl Parsable for u8 {
    type Output = Self;
    fn parse(parser: &mut impl Parser) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u8()
    }
}
impl Parsable for u16 {
    type Output = Self;
    fn parse(parser: &mut impl Parser) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u16()
    }
}
impl Parsable for u32 {
    type Output = Self;
    fn parse(parser: &mut impl Parser) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u32()
    }
}
impl Parsable for u64 {
    type Output = Self;
    fn parse(parser: &mut impl Parser) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u64()
    }
}

impl SizedParsable for u8 {
    const SIZE: usize = 1;
}
impl SizedParsable for u16 {
    const SIZE: usize = 2;
}
impl SizedParsable for u32 {
    const SIZE: usize = 4;
}
impl SizedParsable for u64 {
    const SIZE: usize = 8;
}

pub(crate) trait RandomParsable {
    type Output;
    fn rparse(parser: &impl RandomParser, offset: Offset) -> Result<Self::Output>
    where
        Self::Output: Sized;
}

impl RandomParsable for u8 {
    type Output = Self;
    fn rparse(parser: &impl RandomParser, offset: Offset) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u8(offset)
    }
}
impl RandomParsable for u16 {
    type Output = Self;
    fn rparse(parser: &impl RandomParser, offset: Offset) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u16(offset)
    }
}
impl RandomParsable for u32 {
    type Output = Self;
    fn rparse(parser: &impl RandomParser, offset: Offset) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u32(offset)
    }
}
impl RandomParsable for u64 {
    type Output = Self;
    fn rparse(parser: &impl RandomParser, offset: Offset) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        parser.read_u64(offset)
    }
}