Struct bpx::table::NamedItemTable

pub struct NamedItemTable<T> { /* private fields */ }

Available on crate feature table only.

Helper class to work with named items stored as arrays in a BPX container.

Implementations

impl<T> NamedItemTable<T>

pub fn with_list(list: Vec<T>) -> Self

Constructs a new NamedItemTable from a list of items.

Arguments

• list: the list of items.

returns: ItemTable

pub fn empty() -> Self

Constructs a new empty NamedItemTable.

pub fn iter(&self) -> Iter<'_, T>

Gets all items in this table.

pub fn is_empty(&self) -> bool

Returns true if this table is empty.

pub fn len(&self) -> usize

Returns the number of items in this table.

pub fn get(&self, index: usize) -> Option<&T>

Gets immutable access to an item by its index.

Returns None if the index is out of bounds.

Arguments

• index: the index to find.

returns: Option<&T>

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

Gets mutable access to an item by its index.

Returns None if the index is out of bounds.

Arguments

• index: the index to find.

returns: Option<&mut T>

pub fn remove(&mut self, index: usize)

Removes an item from this table.

Arguments

• index: the index of the item to remove.

returns: ()

impl<T: Item> NamedItemTable<T>

pub fn load_name<'a, T1>(
    &self,
    container: &Container<T1>,
    strings: &'a StringSection,
    item: &T
) -> Result<&'a str, Error>

Load the name of an item.

Arguments

• container: the container to load the string from.
• strings: the string section to use for loading the string.
• item: the item to load the string of.

returns: Result<&str, Error>

Errors

An Error is returned if the strings could not be loaded.

pub fn push(&mut self, name: String, item: T) -> usize

Adds a new item to this table.

Arguments

• name: the name of the item to add.
• item: the item to add.

returns: ()

pub fn find_by_name<T1>(
    &self,
    container: &Container<T1>,
    strings: &StringSection,
    name: &str
) -> Result<Option<&T>, Error>

Lookup an item by its name. Returns None if the item does not exist.

Arguments

• container: the container to load strings from if needed.
• strings: the string section to use for loading strings if needed.
• name: the name to search for.

returns: Result<Option<&T>, Error>

Errors

A Error is returned if the strings could not be loaded.

Trait Implementations

impl<'a, T> IntoIterator for &'a NamedItemTable<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.