brdb 0.5.0

A library for reading and writing Brickadia's World files.
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

use crate::{compression::decompress, errors::BrFsError};

#[derive(Clone, Debug)]
pub struct BrBlob {
    pub blob_id: i64,
    pub compression: i64,
    pub size_uncompressed: i64,
    pub size_compressed: i64,
    pub delta_base_id: Option<i64>, // always null
    pub hash: Vec<u8>,
    pub content: Vec<u8>,
}

impl BrBlob {
    /// Get the BLAKE3 hash of the given content.
    pub fn hash(content: &[u8]) -> [u8; 32] {
        *blake3::hash(content).as_bytes()
    }

    /// Read (and decompress) the content of a blob in the brdb filesystem.
    pub fn read(self) -> Result<Vec<u8>, BrFsError> {
        let content = if self.compression == 0 {
            self.content
        } else {
            // Ensure blob compressed content length is correct
            if self.content.len() != self.size_compressed as usize {
                return Err(BrFsError::InvalidSize {
                    name: "compressed content".to_string(),
                    found: self.content.len(),
                    expected: self.size_compressed as usize,
                });
            }

            // Decompress the content
            decompress(&self.content, self.size_uncompressed as usize)
                .map_err(BrFsError::Decompress)?
        };

        // Verify the size of the decompressed content
        if content.len() != self.size_uncompressed as usize {
            return Err(BrFsError::InvalidSize {
                name: "uncompressed content".to_string(),
                found: content.len(),
                expected: self.size_uncompressed as usize,
            });
        }

        let hash = Self::hash(&content);

        // Verify the hash of the decompressed content
        if hash != self.hash.as_slice() {
            return Err(BrFsError::InvalidHash {
                found: hash.to_vec(),
                expected: self.hash,
            });
        }

        Ok(content)
    }
}

#[derive(Default, Clone, Debug)]
pub struct BrRevision {
    pub revision_id: i64,
    pub description: String,
    pub created_at: i64,
}

#[derive(Default, Clone, Debug)]
pub struct BrFolder {
    pub folder_id: i64,
    pub parent_id: Option<i64>, // references folder_id
    pub name: String,
    pub created_at: i64,
    pub deleted_at: Option<i64>,
}

#[derive(Default, Clone, Debug)]

pub struct BrFile {
    pub file_id: i64,
    pub parent_id: Option<i64>, // references folders(folder_id),
    pub name: String,
    pub content_id: Option<i64>,
    pub created_at: i64,
    pub deleted_at: Option<i64>,
}