bdat 0.5.0-alpha

(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
93
94
95
96
97
98
99
100
101
102
103
104

use crate::{ColumnMap, LegacyTable, ModernTable};

use super::{
    convert::FormatConvertError,
    private::{Column, Table},
};

pub type ModernTableBuilder<'b> = TableBuilderImpl<'b, ModernTable<'b>>;
pub type LegacyTableBuilder<'b> = TableBuilderImpl<'b, LegacyTable<'b>>;

/// A builder interface for tables.
pub struct TableBuilderImpl<'buf, T: Table<'buf>> {
    pub(crate) name: T::Name,
    pub(crate) columns: ColumnMap<T::BuilderColumn, <T::BuilderColumn as Column>::Name>,
    pub(crate) base_id: T::Id,
    pub(crate) rows: Vec<T::BuilderRow>,
}

impl<'b, T> TableBuilderImpl<'b, T>
where
    T: Table<'b>,
{
    pub fn with_name(name: impl Into<T::Name>) -> Self {
        Self {
            name: name.into(),
            base_id: 1.into(), // more sensible default, it's very rare for a table to have 0
            columns: ColumnMap::default(),
            rows: vec![],
        }
    }

    pub(crate) fn from_table(
        name: T::Name,
        base_id: T::Id,
        columns: ColumnMap<T::BuilderColumn, <T::BuilderColumn as Column>::Name>,
        rows: Vec<T::BuilderRow>,
    ) -> Self {
        Self {
            name,
            columns,
            base_id,
            rows,
        }
    }

    pub fn add_column(mut self, column: impl Into<T::BuilderColumn>) -> Self {
        self.columns.push(column.into());
        self
    }

    /// Adds a new row at the end of the table.
    pub fn add_row(mut self, row: impl Into<T::BuilderRow>) -> Self {
        self.rows.push(row.into());
        self
    }

    /// Sets the entire row list for the table.
    pub fn set_rows(mut self, rows: Vec<T::BuilderRow>) -> Self {
        self.rows = rows;
        self
    }

    pub fn set_columns(mut self, columns: impl IntoIterator<Item = T::BuilderColumn>) -> Self {
        self.columns = columns.into_iter().collect();
        self
    }

    pub fn set_base_id(mut self, base_id: T::Id) -> Self {
        self.base_id = base_id;
        self
    }
}

/// Modern builder -> Modern table
impl<'b> ModernTableBuilder<'b> {
    pub fn try_build(self) -> Result<ModernTable<'b>, FormatConvertError> {
        // No need for MaxRowCountExceeded here, we panic on row insertions if
        // the limit is reached, and all legacy table formats have a lower limit
        // than modern tables.
        Ok(ModernTable::new(self))
    }

    pub fn build(self) -> ModernTable<'b> {
        self.try_build().unwrap()
    }
}

/// Legacy builder -> Legacy table
impl<'b> LegacyTableBuilder<'b> {
    pub fn try_build(self) -> Result<LegacyTable<'b>, FormatConvertError> {
        let rows =
            u16::try_from(self.rows.len()).map_err(|_| FormatConvertError::MaxRowCountExceeded)?;
        if self.base_id.checked_add(rows).is_none() {
            // If there are enough rows to overflow from base_id, then we definitely have a row
            // with ID u16::MAX
            return Err(FormatConvertError::UnsupportedRowId(u16::MAX as u32));
        }
        Ok(LegacyTable::new(self))
    }

    pub fn build(self) -> LegacyTable<'b> {
        self.try_build().unwrap()
    }
}