Struct AssetRegistry 

pub struct AssetRegistry { /* private fields */ }

The named assets that the app loads by path, such as images, SVGs and fonts.

Set the registry with crate::Application::with_assets and read it with crate::App::assets. Paths are exact lookup keys such as "icons/star.svg"; the registry does not resolve them against the filesystem. Each path has one AssetEntry and can be registered only once. Build a registry with AssetRegistry::insert, AssetRegistry::extend or collect(), or convert an AssetSource.

Implementations

impl AssetRegistry

pub fn insert( &mut self, path: impl Into<SharedString>, asset: impl Into<AssetEntry>, ) -> Result<(), DuplicateAssetPath>

Adds the asset at path.

The asset can be Cow::Borrowed(&'static [u8]) for static bytes, Cow::Owned(Vec<u8>) for bytes you already have, or a closure that returns them on demand (see FnAssetLoader).

Errors

Returns DuplicateAssetPath if path is already registered. The existing entry is kept.

Examples

let mut assets = AssetRegistry::default();
assets
    .insert(
        "icons/star.svg",
        Cow::Borrowed(
            &b"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 8 8\"><rect width=\"8\" height=\"8\"/></svg>"[..],
        ),
    )
    .unwrap();

assert!(assets.load("icons/star.svg").is_some());
assert!(assets.load("icons/missing.svg").is_none());
assert!(assets.insert("icons/star.svg", Cow::Borrowed(&b""[..])).is_err());

pub fn load<'this>( &'this self, path: impl AsRef<str>, ) -> Option<Cow<'this, [u8]>>

Returns the bytes at path, or None if the path isn’t registered.

Preloaded entries are returned as Cow::Borrowed with no copy. An on-demand entry runs its loader on each call, so the bytes may be read from disk again. An on-demand loader that returns None makes this return None too.

pub fn extend<IterType, KeyType, EntryType>( &mut self, into_iter: IterType, ) -> Result<(), Vec<DuplicateAssetPath>>

where IterType: IntoIterator<Item = (KeyType, EntryType)>, KeyType: AsRef<str>, EntryType: Into<AssetEntry>,

Adds each (path, entry) pair in order.

Errors

Returns the DuplicateAssetPath of every pair whose path was already registered, in order. The other pairs are still added, and each duplicate is logged.

Trait Implementations

impl Default for AssetRegistry

fn default() -> Self

Returns the “default value” for a type.

impl From<Arc<dyn AssetSource>> for AssetRegistry

Converts the provided AssetSource into a fresh AssetRegistry where all entries in the asset source are loaded OnDemand via AssetSource::iter_ondemand.

fn from(value: Arc<dyn AssetSource>) -> Self

Converts to this type from the input type.

impl<T: AssetSource + 'static> From<T> for AssetRegistry

fn from(value: T) -> Self

Converts to this type from the input type.

impl<KeyType, ValueType> FromIterator<(KeyType, ValueType)> for AssetRegistry

where KeyType: AsRef<str>, ValueType: Into<AssetEntry>,

fn from_iter<T: IntoIterator<Item = (KeyType, ValueType)>>(iter: T) -> Self

Creates a value from an iterator.