Struct jupiter::repository::loader::LoaderInfo

pub struct LoaderInfo { /* private fields */ }

Wraps the metadata as well as the files being involved into a single struct which is provided to all loaders which loading or unloading data.

Implementations

impl LoaderInfo

pub fn loader_file_name(&self) -> Cow<'_, str>

Extracts the name of the file used to configure the loader.

pub fn file_name(&self) -> Cow<'_, str>

Extracts the name of the file being loaded.

pub fn last_error(&self) -> String

Retrieves the last known error this loader reported.

pub fn store_error(&self, error: String)

Stores an error for this loader.

Note that this shouldn’t be called manually, as the background actor of the repository (which invokes the loaders) already takes care of reporting errors. The loader itself is of course in charge to create and report proper error when called.

pub fn get_loader(&self) -> &Arc<dyn Loader>

Provides access to the actual loader in charge.

pub fn get_config(&self) -> &Yaml

Provides access to the metadata of the loader.

pub fn get_data(&self) -> &Path

Returns the data file to load or unload.

pub async fn get_data_str(&self) -> Result<String>

Fetches the contents of the data file as string.

Trait Implementations

impl Clone for LoaderInfo

fn clone(&self) -> LoaderInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoaderInfo

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

Formats the value using the given formatter.

impl Display for LoaderInfo

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

Formats the value using the given formatter.