Struct Store

pub struct Store {
    pub datasets: HashMap<String, AssetInfo>,
    pub results: HashMap<String, PathBuf>,
}

Defines a JSON file that the administrator writes that contains the hardcoded data files.

Note that this struct is not read from its file as-is. Instead, it is defined as a vector of AssetInfos (i.e., Vec<AssetInfo>).

For network serialization/deserialization, it is preferred to send the entire map in one go.

Fields

datasets: HashMap<String, AssetInfo>

A list of locally defined AssetInfos.

results: HashMap<String, PathBuf>

A list of locally defined AssetInfos for the intermediate results.

Implementations

impl Store

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

Constructor for the Store that loads it from the given path.

Arguments

• path: The Path(-like) that tells us where the file lives.

Returns

A new Store instance that contains the datasets in this domain.

Errors

This function may error if we could not open or read the given File, or parse it as Store-file YAML.

pub fn from_reader(reader: impl Read) -> Result<Self, Error>

Constructor for the Store that loads it from the given reader.

Arguments

• reader: The Read-capable type that interfaces us with the Store file.

Returns

A new Store instance that contains the datasets in this domain.

Errors

This function may error if we could not open or read the given File, or parse it as Store-file YAML.

pub async fn from_dirs( data_path: impl AsRef<Path>, results_path: impl AsRef<Path>, ) -> Result<Self, Error>

Construtctor for the Store that deduces its contents from the contents in the given directory.

Arguments

• data_path: The path of the directory where all datasets are stored.
• results_path: The path of the directory where all intermediate results are stored.

Returns

A new Store instance that contains the datasets & results for this domain.

Errors

This function errors if we failed to read the given directory, or any of the data directories were ill-formed.

pub fn get_data(&self, name: impl AsRef<str>) -> Option<&AssetInfo>

Get the AssetInfo for the given dataset.

Arguments

• name: The name of the dataset to get the AssetInfo for.

Returns

The dataset if it exists, or else None.

pub fn get_result(&self, name: impl AsRef<str>) -> Option<&PathBuf>

Get the path for the given intermediate result.

Arguments

• name: The name of the intermediate result to get the AssetInfo for.

Returns

The path to the intermediate result if it exists, or else None.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Store

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

Formats the value using the given formatter.