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
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

use crate::schema::BrdbSchema;
use std::sync::OnceLock;

pub const GLOBAL_DATA_SOA: &str = "BRSavedGlobalDataSoA";
pub const BRICK_CHUNK_SOA: &str = "BRSavedBrickChunkSoA";
pub const BRICK_COMPONENT_SOA: &str = "BRSavedComponentChunkSoA";
pub const BRICK_WIRE_SOA: &str = "BRSavedWireChunkSoA";
pub const BRICK_CHUNK_INDEX_SOA: &str = "BRSavedBrickChunkIndexSoA";
pub const ENTITY_CHUNK_SOA: &str = "BRSavedEntityChunkSoA";
pub const ENTITY_CHUNK_INDEX_SOA: &str = "BRSavedEntityChunkIndexSoA";
pub const OWNER_TABLE_SOA: &str = "BRSavedOwnerTableSoA";

/// World/0/GlobalData.schema
pub fn global_data_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) =
            BrdbSchema::parse_to_meta(include_str!("../../schemas/BRSavedGlobalDataSoA.schema"))
                .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}
/// World/0/Bricks/ChunksShared.schema
pub fn bricks_chunks_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) =
            BrdbSchema::parse_to_meta(include_str!("../../schemas/BRSavedBrickChunkSoA.schema"))
                .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Bricks/ChunkIndexShared.schema
pub fn bricks_chunk_index_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) = BrdbSchema::parse_to_meta(include_str!(
            "../../schemas/BRSavedBrickChunkIndexSoA.schema"
        ))
        .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Bricks/ComponentsShared.schema
pub fn bricks_components_schema_min() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) = BrdbSchema::parse_to_meta(include_str!(
            "../../schemas/BRSavedComponentChunkSoA.schema"
        ))
        .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Bricks/ComponentsShared.schema
pub fn bricks_components_schema_max() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) = BrdbSchema::parse_to_meta(include_str!(
            "../../schemas/BRSavedComponentChunkSoA_max.schema"
        ))
        .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Bricks/WiresShared.schema
pub fn bricks_wires_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) =
            BrdbSchema::parse_to_meta(include_str!("../../schemas/BRSavedWireChunkSoA.schema"))
                .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Owners.schema
pub fn owners_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) =
            BrdbSchema::parse_to_meta(include_str!("../../schemas/BRSavedOwnerTableSoA.schema"))
                .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Entities/ChunkIndex.schema
pub fn entities_chunk_index_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) = BrdbSchema::parse_to_meta(include_str!(
            "../../schemas/BRSavedEntityChunkIndexSoA.schema"
        ))
        .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

/// World/0/Entities/ChunksShared.schema
pub fn entities_chunks_schema() -> &'static BrdbSchema {
    static SCHEMA: OnceLock<BrdbSchema> = OnceLock::new();

    &SCHEMA.get_or_init(|| {
        let (enums, structs) =
            BrdbSchema::parse_to_meta(include_str!("../../schemas/BRSavedEntityChunkSoA.schema"))
                .unwrap();
        BrdbSchema::from_meta(enums, structs)
    })
}

#[cfg(test)]
mod test {
    /// Ensure the above schemas compile and can be instantiated.
    #[test]
    fn test_schema() {
        use super::*;
        let _ = global_data_schema();
        let _ = bricks_chunks_schema();
        let _ = bricks_chunk_index_schema();
        let _ = bricks_components_schema_min();
        let _ = bricks_components_schema_max();
        let _ = bricks_wires_schema();
        let _ = owners_schema();
        let _ = entities_chunk_index_schema();
        let _ = entities_chunks_schema();
    }
}