Struct AssetLibrary

pub struct AssetLibrary {
    version: Version,
    registered_packs: HashMap<String, AssetLibraryEntry>,
    loaded_packs: HashMap<String, AssetPack>,
}

An AssetLibrary is a device-wide registry of packs that save files can refer to. It handles as the bridge between relative paths within an asset pack and the actual paths on a user’s device.

Fields

version: Version

The version of the software that last touched the library, used to help with future migrations.

registered_packs: HashMap<String, AssetLibraryEntry>

A map of asset packs, keyed by their (public) identifiers.

loaded_packs: HashMap<String, AssetPack>

A map of currently loaded asset packs, keyed by their (public) identifiers.

Given that this map is only persisted for the runtime of the application, it’s possible that an AssetPack is ‘known’ but not loaded.

Implementations

impl AssetLibrary

pub fn load_or_default(path: Option<PathBuf>) -> Result<Self, AssetLibraryError>

Attempts to AssetLibrary::load the library from path, and returns the default value on [IOError].

Any other error will be propagated by this method.

Errors

See AssetLibrary::load.

pub fn load(path: Option<PathBuf>) -> Result<Self, AssetLibraryError>

Attempts to load the asset library from path, where path is the configuration directory. If None is passed, the [utils::config_path] method is used instead.

Errors

An error can be returned for the following situations:

• The configuration folder could not be retrieved: AssetLibraryError::LocateConfigFolder
• An error occurs while trying to read the config file (doesn’t exist, permissions, …): AssetLibraryError::LocateConfigFolder
• The file was found, could be read but failed to deserialize: [AssetLibraryError::Serialization].

pub fn delete(&mut self) -> Result<(), AssetLibraryError>

Recursively removes all cache and config of all packs and the library itself. To clean up a specific AssetPack, use AssetLibrary::delete_pack.

Errors

See errors returned by AssetLibrary::delete_pack.

pub fn delete_pack(&mut self, id: &String) -> Result<(), AssetLibraryError>

Attempts to delete cache and config files of a given AssetPack and then unregisters it from the library.

Errors

If any IO related errors occur while removing the pack, this method can return a AssetLibraryError::OpenAssetPack.

pub fn save(&self, path: Option<PathBuf>) -> Result<(), AssetLibraryError>

Saves the asset library.

Errors

An error can be returned for the following situations:

• The configuration folder could not be retrieved: AssetLibraryError::LocateConfigFolder
• An error occurs while trying to read the config file (doesn’t exist, permissions, …): AssetLibraryError::LocateConfigFolder
• The file was found, could be read but failed to deserialize: [AssetLibraryError::Serialization].

pub fn add_pack( &mut self, root: &Path, name: Option<String>, ) -> Result<String, AssetLibraryError>

Registers a new AssetPack in the library and returns the AssetPack’s ID.

Note that you should only use this to create a new pack, not to load an existing one.

Errors

• The configuration folder could not be retrieved: AssetLibraryError::LocateConfigFolder
• An error occurs while trying to read the config file (doesn’t exist, permissions, …): AssetLibraryError::LocateConfigFolder
• The file was found, could be read but failed to deserialize: [AssetLibraryError::Serialization].

pub fn load_pack( &mut self, id: &String, ) -> Result<&mut AssetPack, AssetLibraryError>

Attempt to load a previously registered AssetPack.

Errors

• If the asset pack isn’t previously registered using AssetLibrary::add_pack this method returns AssetLibraryError::NotFound.
• If an error occurs while loading the AssetPack, it returns AssetLibraryError::OpenAssetPack.

pub fn is_pack_loaded(&self, id: &String) -> bool

Adds a method to check if a given AssetPack is already loaded in the current library.

pub fn is_pack_registered(&self, id: &String) -> bool

Checks whether an asset pack is “known” (registered) within the current asset library.

You can register new asset packs using AssetLibrary::add_pack.

pub fn get_pack(&self, id: &String) -> Option<&AssetPack>

Attempts to retrieve an previously loaded AssetPack from the current library.

If None is returned the pack either doesn’t exist or hasn’t been loaded yet (see AssetLibrary::load_pack).

pub fn get_pack_mut(&mut self, id: &String) -> Option<&mut AssetPack>

Attempts to retrieve an previously loaded AssetPack from the current library.

If None is returned the pack either doesn’t exist or hasn’t been loaded yet (see AssetLibrary::load_pack).

pub fn iter(&self) -> impl Iterator<Item = (&String, &PathBuf)>

Iterator over all registered packs.

fn get_path(path: Option<PathBuf>) -> Result<PathBuf, AssetLibraryError>

Either returns path or config_path() if path is None.

Errors

Returns an error if the configuration folder cannot be found.

Trait Implementations

impl Debug for AssetLibrary

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

Formats the value using the given formatter.

impl Default for AssetLibrary

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AssetLibrary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AssetLibrary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Resource for AssetLibrary

where Self: Send + Sync + 'static,