bdat 0.6.0

(De)serialization library for Monolithsoft's BDAT file 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

use crate::compat::CompatTable;
use crate::error::Result;
use crate::table::legacy::LegacyTable;
use crate::table::modern::ModernTable;
use crate::Label;
use std::collections::HashMap;
use std::io::Cursor;
use std::marker::PhantomData;

pub struct BdatReader<R, E> {
    pub(crate) stream: R,
    pub(crate) table_offset: usize,
    _endianness: PhantomData<E>,
}

#[derive(Clone)]
pub struct BdatSlice<'b, E> {
    pub(crate) data: Cursor<&'b [u8]>,
    pub(crate) table_offset: usize,
    _endianness: PhantomData<E>,
}

/// Table extractor from a BDAT file.
///
/// ## Notice
/// In future versions, this may be replaced by a common file struct.
pub trait BdatFile<'b> {
    /// The output table type
    type TableOut;

    /// Reads all tables from the BDAT source.
    fn get_tables(&mut self) -> Result<Vec<Self::TableOut>>;

    /// Returns the number of tables in the BDAT file.
    fn table_count(&self) -> usize;

    /// Reads all tables from the BDAT source, then groups them by name.
    fn get_tables_by_name(&mut self) -> Result<HashMap<Label<'b>, Self::TableOut>>
    where
        Self::TableOut: TableName<'b>,
        Self: 'b,
    {
        self.get_tables().map(|tables| {
            tables
                .into_iter()
                .map(|t| (t.name(), t)) // TODO
                .collect()
        })
    }
}

pub trait TableName<'b> {
    fn name(&self) -> Label<'b>;
}

impl<'b, E> BdatSlice<'b, E> {
    pub fn new(bytes: &'b [u8]) -> Self {
        Self {
            data: Cursor::new(bytes),
            table_offset: 0,
            _endianness: PhantomData,
        }
    }
}

impl<R, E> BdatReader<R, E> {
    pub fn new(reader: R) -> Self {
        Self {
            stream: reader,
            table_offset: 0,
            _endianness: PhantomData,
        }
    }
}

impl<'b> TableName<'b> for ModernTable<'b> {
    fn name(&self) -> Label<'b> {
        self.name.clone()
    }
}

impl<'b> TableName<'b> for LegacyTable<'b> {
    fn name(&self) -> Label<'b> {
        self.name.clone().into()
    }
}

impl<'b> TableName<'b> for CompatTable<'b> {
    fn name(&self) -> Label<'b> {
        self.name_cloned()
    }
}