Struct LegacyTable

pub struct LegacyTable<'b> { /* private fields */ }

The BDAT table representation in legacy formats, used for all games before Xenoblade 3.

Characteristics

Cell types

Unlike modern tables, legacy tables can have multiple-value cells, or mask a value’s bits to create flags.

See also: LegacyRow

Examples

Operating on cells

use bdat::{Label, legacy::LegacyTable, label_hash};

fn get_character_id(table: &LegacyTable, row_id: u16) -> u32 {
    let cell = table.row(row_id).get("CharacterID");
    // Unlike modern tables, we can't simply operate on the value.
    // We can `match` on cell types, or simply cast them and handle errors:
    cell.as_single().unwrap().get_as::<u32>()
}

Implementations

impl<'b> LegacyTable<'b>

pub fn name(&self) -> &str

pub fn set_name(&mut self, name: Utf<'b>)

pub fn base_id(&self) -> u16

Gets the minimum row ID in the table.

pub fn row(&self, id: u16) -> LegacyRowRef<'_, 'b>

Gets a row by its ID.

Note: the ID is the row’s numerical ID, which could be different from the index of the row in the table’s row list. That is because BDAT tables can have arbitrary start IDs.

Panics

If there is no row for the given ID.

pub fn row_mut(&mut self, id: u16) -> LegacyRowMut<'_, 'b>

Gets a mutable view of a row by its ID

Note: the ID is the row’s numerical ID, which could be different from the index of the row in the table’s row list. That is because BDAT tables can have arbitrary start IDs.

Panics

If there is no row for the given ID

pub fn get_row(&self, id: u16) -> Option<LegacyRowRef<'_, 'b>>

Attempts to get a row by its ID.
If there is no row for the given ID, this returns None.

Note: the ID is the row’s numerical ID, which could be different from the index of the row in the table’s row list. That is because BDAT tables can have arbitrary start IDs.

pub fn get_row_mut(&mut self, id: u16) -> Option<LegacyRowMut<'_, 'b>>

Attempts to get a mutable view of a row by its ID.
If there is no row for the given ID, this returns None.

Note: the ID is the row’s numerical ID, which could be different from the index of the row in the table’s row list. That is because BDAT tables can have arbitrary start IDs.

pub fn rows(&self) -> impl Iterator<Item = LegacyRowRef<'_, 'b>>

Gets an iterator that visits this table’s rows

pub fn rows_mut(&mut self) -> impl Iterator<Item = LegacyRowMut<'_, 'b>>

Gets an iterator over mutable references to this table’s rows.

The iterator does not allow structural modifications to the table. To add, remove, or reorder rows, convert the table to a new builder first. (TableBuilder::from(table))

pub fn into_rows(self) -> impl Iterator<Item = LegacyRow<'b>>

Gets an owning iterator over this table’s rows

pub fn into_rows_id(self) -> impl Iterator<Item = (u16, LegacyRow<'b>)>

Gets an owning iterator over this table’s rows, in pairs of (row ID, row).

pub fn columns(&self) -> impl Iterator<Item = &LegacyColumn<'b>>

Gets an iterator that visits this table’s column definitions

pub fn columns_mut(&mut self) -> impl Iterator<Item = &mut LegacyColumn<'b>>

Gets an iterator over mutable references to this table’s column definitions.

pub fn into_columns(self) -> impl Iterator<Item = LegacyColumn<'b>>

Gets an owning iterator over this table’s column definitions

pub fn row_count(&self) -> usize

pub fn column_count(&self) -> usize

Trait Implementations

impl<'b> Clone for LegacyTable<'b>

fn clone(&self) -> LegacyTable<'b>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'b> Debug for LegacyTable<'b>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'b> From<LegacyTable<'b>> for CompatTable<'b>

fn from(value: LegacyTable<'b>) -> Self

Converts to this type from the input type.

impl<'b> From<LegacyTable<'b>> for LegacyTableBuilder<'b>

fn from(value: LegacyTable<'b>) -> Self

Converts to this type from the input type.

impl<'b> PartialEq for LegacyTable<'b>

fn eq(&self, other: &LegacyTable<'b>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'b> TryFrom<LegacyTable<'b>> for ModernTable<'b>

type Error = FormatConvertError

The type returned in the event of a conversion error.

fn try_from(legacy_table: LegacyTable<'b>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'b> TryFrom<ModernTable<'b>> for LegacyTable<'b>

type Error = FormatConvertError

The type returned in the event of a conversion error.

fn try_from(modern_table: ModernTable<'b>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'b> StructuralPartialEq for LegacyTable<'b>