bindle-file 0.1.0

an efficient binary archive 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

use zerocopy::{FromBytes, Immutable, IntoBytes, Unaligned};

use crate::compress::Compress;

/// Metadata for an entry in the archive.
///
/// Contains information about stored files including offset, size, compression, and CRC32 checksum.
/// Retrieved via the archive's `index()` method.
#[repr(C, packed)]
#[derive(FromBytes, Unaligned, IntoBytes, Immutable, Clone, Copy, Debug, Default)]
pub struct Entry {
    offset: u64,
    compressed_size: u64,
    uncompressed_size: u64,
    crc32: u32,
    name_len: u16,
    pub compression_type: u8,
    pub _reserved: u8,
}

// The binary format uses little-endian byte order for all multi-byte integers.
// These methods handle endianness conversion transparently:
// - On little-endian systems (x86, ARM): zero overhead, direct access
// - On big-endian systems: bytes are swapped to/from little-endian

impl Entry {
    /// Returns the byte offset where this entry's data starts in the archive.
    pub fn offset(&self) -> u64 {
        u64::from_le(self.offset)
    }

    pub(crate) fn set_offset(&mut self, value: u64) {
        self.offset = value.to_le();
    }

    /// Returns the compressed size of this entry in bytes.
    pub fn compressed_size(&self) -> u64 {
        u64::from_le(self.compressed_size)
    }

    pub(crate) fn set_compressed_size(&mut self, value: u64) {
        self.compressed_size = value.to_le();
    }

    /// Returns the uncompressed size of this entry in bytes.
    pub fn uncompressed_size(&self) -> u64 {
        u64::from_le(self.uncompressed_size)
    }

    pub(crate) fn set_uncompressed_size(&mut self, value: u64) {
        self.uncompressed_size = value.to_le();
    }

    /// Returns the CRC32 checksum of the uncompressed data.
    pub fn crc32(&self) -> u32 {
        u32::from_le(self.crc32)
    }

    pub(crate) fn set_crc32(&mut self, value: u32) {
        self.crc32 = value.to_le();
    }

    /// Returns the length of the entry name in bytes.
    pub fn name_len(&self) -> usize {
        u16::from_le(self.name_len) as usize
    }

    pub(crate) fn set_name_len(&mut self, value: u16) {
        self.name_len = value.to_le();
    }

    /// Returns the compression type for this entry.
    pub fn compression_type(&self) -> Compress {
        Compress::from_u8(self.compression_type)
    }
}

#[repr(C, packed)]
#[derive(FromBytes, Unaligned, IntoBytes, Immutable, Debug)]
pub(crate) struct Footer {
    pub index_offset: u64,
    pub entry_count: u32,
    pub magic: u32,
}

impl Footer {
    pub fn new(index_offset: u64, entry_count: u32, magic: u32) -> Self {
        Self {
            index_offset: index_offset.to_le(),
            entry_count: entry_count.to_le(),
            magic: magic.to_le(),
        }
    }

    pub fn index_offset(&self) -> u64 {
        u64::from_le(self.index_offset)
    }

    pub fn entry_count(&self) -> u32 {
        u32::from_le(self.entry_count)
    }

    pub fn magic(&self) -> u32 {
        u32::from_le(self.magic)
    }
}