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

use super::{EntryRange, EntryStorage, EntryStore, RangeTrait};
use crate::bases::*;
use std::sync::Arc;

#[derive(Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "explorable",
    derive(serde::Serialize),
    serde(rename = "Index")
)]
pub(crate) struct IndexHeader {
    pub store_id: EntryStoreIdx,
    pub entry_count: EntryCount,
    pub entry_offset: EntryIdx,
    pub free_data: IndexFreeData,
    pub index_property: u8,
    pub name: String,
}

impl Parsable for IndexHeader {
    type Output = Self;
    fn parse(parser: &mut impl Parser) -> Result<Self> {
        let store_id = Idx::<u32>::parse(parser)?.into();
        let entry_count = Count::<u32>::parse(parser)?.into();
        let entry_offset = Idx::<u32>::parse(parser)?.into();
        let free_data = IndexFreeData::parse(parser)?;
        let index_property = parser.read_u8()?;
        let name = String::from_utf8(PString::parse(parser)?)?;
        Ok(Self {
            store_id,
            entry_count,
            entry_offset,
            free_data,
            index_property,
            name,
        })
    }
}

impl BlockParsable for IndexHeader {}

#[derive(Debug)]
#[cfg_attr(feature = "explorable", derive(serde::Serialize), serde(transparent))]

pub struct Index {
    header: IndexHeader,
}

impl Index {
    pub(crate) fn new(header: IndexHeader) -> Self {
        Self { header }
    }

    pub fn get_store(&self, entry_storage: &EntryStorage) -> Result<Arc<EntryStore>> {
        Ok(Arc::clone(
            entry_storage.get_entry_store(self.header.store_id)?,
        ))
    }

    pub fn get_store_id(&self) -> EntryStoreIdx {
        self.header.store_id
    }

    pub fn size(&self) -> EntryCount {
        self.header.entry_count
    }

    pub fn is_empty(&self) -> bool {
        self.header.entry_count.into_u32() == 0
    }
}

impl From<&Index> for EntryRange {
    fn from(index: &Index) -> Self {
        Self::new_from_size(index.offset(), index.count())
    }
}

impl RangeTrait for Index {
    fn offset(&self) -> EntryIdx {
        self.header.entry_offset
    }

    fn count(&self) -> EntryCount {
        self.header.entry_count
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_index() {
        let content = vec![
            0x01, 0x00, 0x00, 0x00, // store_id
            0x00, 0xff, 0x00, 0x00, // entry_count
            0x02, 0x00, 0x00, 0x00, // entry_offset
            0x00, 0x00, 0x00, 0x00, // free data
            0x01, // index_property
            0x05, 0x48, 0x65, 0x6C, 0x6C, 0x6F, // PString Hello
            0x40, 0x0E, 0x8C, 0xFA,
        ];
        let reader = Reader::from(content);
        let header = reader
            .parse_block_in::<IndexHeader>(Offset::zero(), 23.into())
            .unwrap();
        assert_eq!(
            header,
            IndexHeader {
                store_id: EntryStoreIdx::from(1),
                entry_count: EntryCount::from(0xff00),
                entry_offset: EntryIdx::from(2),
                free_data: [0x00; 4].into(),
                index_property: 1,
                name: String::from("Hello")
            }
        );
    }
}