Struct keeshond_datapack::DataStore

pub struct DataStore<T: DataObject + 'static> { /* fields omitted */ }

Storage that allows lookup and access of DataObjects of a given type

Methods

impl<T: DataObject + 'static> DataStore<T>

pub fn new(source_manager: Rc<RefCell<SourceManager>>) -> DataStore<T>

Constructs a new DataStore that gets its Sources from the given SourceManager

pub fn load_package(
    &mut self,
    package_name: &str
) -> Result<DataStoreOk, DataError>

Loads the package by the given name if it is not already loaded.

pub fn get_id(
    &self,
    package_name: &str,
    pathname: &str
) -> Result<DataId, DataError>

Gets the numeric ID of the DataObject from the given package at the given pathname.

pub fn get_id_mut(
    &mut self,
    package_name: &str,
    pathname: &str
) -> Result<DataId, DataError>

Gets the numeric ID of the DataObject from the given package at the given pathname. If the package is not loaded, it will be loaded automatically.

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

Returns a reference to the DataObject by the given DataId, if one exists. Otherwise returns None.

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

Returns a mutable reference to the DataObject by the given DataId, if one exists. Otherwise returns None.

pub fn list_package_contents(&self, package_name: &str) -> Vec<String>

Returns a string list of the names of each DataObject in the given package. The package will need to have been loaded or this will return an empty list. Please do not call this repeatedly.

pub fn unload_package(&mut self, package_name: &str) -> bool

Unloads the given package from memory. Any DataObjects will be dropped, but pathname-id mappings will be retained in memory so that existing references will not be invalidated. Returns true if the package was loaded.

pub fn unload_all(&mut self)

Unloads all packages from memory. Any DataObjects will be dropped, but pathname-id mappings will be retained in memory so that existing references will not be invalidated. Returns true if the package was loaded.

pub fn package_loaded(&self, package_name: &str) -> bool

Returns true if the given package is loaded.