Struct ResourceRegistry 

pub struct ResourceRegistry {
    pub excluded_folders: FxHashSet<PathBuf>,
    /* private fields */
}

Resource registry is responsible for UUID mapping of resource files. It maintains a map of UUID -> Resource Path.

Fields

excluded_folders: FxHashSet<PathBuf>

A list of folder that should be excluded when scanning the project folder for supported resources. By default, it contains ./target (a folder with build artifacts) and ./build (a folder with production builds) folders.

Implementations

impl ResourceRegistry

pub const DEFAULT_PATH: &'static str = "data/resources.registry"

Default path of the registry. It can be overridden on a registry instance using Self::set_path method.

pub fn new(io: Arc<dyn ResourceIo>) -> Self

Creates a new resource registry with the given resource IO.

pub fn status_flag(&self) -> ResourceRegistryStatusFlag

Returns a shared reference to the status flag. See ResourceRegistryStatusFlag docs for more info.

pub fn normalize_path(&self, path: impl AsRef<Path>) -> PathBuf

Normalizes the path by resolving all . and .. and removing any prefixes. Absolute paths are converted to relative paths by removing the project root prefix, if possible. Also replaces \\ slashes to cross-platform / slashes.

Panics

Panics if the given path is invalid, such as if it includes a directory that does not exist.

pub fn inner(&self) -> &RegistryContainer

Returns a reference to the actual container of the resource entries.

pub fn set_path(&mut self, path: impl AsRef<Path>)

Sets a new path for the registry, but does not saves it.

pub fn path(&self) -> &Path

Returns a path to which the resource registry is (or may) be saved.

pub fn directory(&self) -> Option<&Path>

Returns a directory to which the resource registry is (or may) be saved.

pub async fn save(&self)

Asynchronously saves the registry.

pub fn exists_sync(&self) -> bool

Returns true if the resource registry file exists, false - otherwise.

pub fn save_sync(&self)

Same as Self::save, but synchronous.

pub fn modify(&mut self) -> ResourceRegistryRefMut<'_>

Begins registry modification. See ResourceRegistryRefMut docs for more info.

pub fn uuid_to_path(&self, uuid: Uuid) -> Option<&Path>

Tries to get a path associated with the given resource UUID.

pub fn uuid_to_path_buf(&self, uuid: Uuid) -> Option<PathBuf>

Same as Self::uuid_to_path, but returns PathBuf instead of &Path.

pub fn path_to_uuid(&self, path: &Path) -> Option<Uuid>

Tries to find a UUID that corresponds for the given path.

pub fn is_registered(&self, path: &Path) -> bool

Checks if the path is registered in the resource registry.

pub async fn scan( resource_io: Arc<dyn ResourceIo>, loaders: Arc<Mutex<ResourceLoadersContainer>>, root: impl AsRef<Path>, excluded_folders: FxHashSet<PathBuf>, ) -> RegistryContainer

Searches for supported resources starting from the given path and builds a mapping UUID -> Path. If a supported resource does not have a metadata file besides it, this method will automatically create the metadata file with a new UUID and add the resource to the registry.

This method does not load any resource, instead it checks extension of every file in the given directory, and if there’s a loader for it, “remember” the resource.

Trait Implementations

impl Clone for ResourceRegistry

fn clone(&self) -> ResourceRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.