Struct assets_manager::LocalAssetCache

pub struct LocalAssetCache<S = FileSystem> { /* private fields */ }

Single-threaded version of AssetCache.

This type is not thread-safe, but is cheaper if you don’t need synchronization. It still requires stored assets to be thread-safe.

This cache does not support hot-reloading.

Implementations

impl LocalAssetCache

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a new LocalAssetCache that reads assets from the given directory.

impl<S> LocalAssetCache<S>

pub fn with_source(source: S) -> Self

Creates a new LocalAssetCache with the given source.

impl<S: Source> LocalAssetCache<S>

pub fn get_cached<T: Storable>(&self, id: &str) -> Option<&Handle<T>>

Gets a value from the cache.

See AnyCache::get_cached for more details.

pub fn get_or_insert<T: Storable>(&self, id: &str, default: T) -> &Handle<T>

Gets a value from the cache or inserts one.

See AnyCache::get_or_insert for more details.

pub fn contains<T: Storable>(&self, id: &str) -> bool

Returns true if the cache contains the specified asset.

See AnyCache::contains for more details.

pub fn load<T: Compound>(&self, id: &str) -> Result<&Handle<T>, Error>

Loads an asset.

See AnyCache::load for more details.

pub fn load_expect<T: Compound>(&self, id: &str) -> &Handle<T>

Loads an asset and panic if an error happens.

See AnyCache::load_expect for more details.

pub fn load_dir<T: DirLoadable>( &self, id: &str ) -> Result<&Handle<Directory<T>>, Error>

Loads all assets of a given type from a directory.

See AnyCache::load_dir for more details.

pub fn load_rec_dir<T: DirLoadable>( &self, id: &str ) -> Result<&Handle<RecursiveDirectory<T>>, Error>

Loads all assets of a given type from a directory.

See AnyCache::load_dir for more details.

pub fn load_owned<T: Compound>(&self, id: &str) -> Result<T, Error>

Loads an owned version of an asset.

See AnyCache::load_owned for more details.

pub fn as_any_cache(&self) -> AnyCache<'_>

Converts to an AnyCache.

impl<S> LocalAssetCache<S>

pub fn remove<T: Storable>(&mut self, id: &str) -> bool

Removes an asset from the cache, and returns whether it was present in the cache.

Note that you need a mutable reference to the cache, so you cannot have any Handle, AssetReadGuard, etc when you call this function.

pub fn take<T: Storable>(&mut self, id: &str) -> Option<T>

Takes ownership on a cached asset.

The corresponding asset is removed from the cache.

pub fn clear(&mut self)

Clears the cache.

Removes all cached assets and directories.

Trait Implementations

impl<'a, S: Source> AsAnyCache<'a> for &'a LocalAssetCache<S>

fn as_any_cache(&self) -> AnyCache<'a>

Converts this type to an AnyCache.

impl<S> Debug for LocalAssetCache<S>

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

Formats the value using the given formatter.

impl<S> Default for LocalAssetCache<S>

where S: Source + Default,

fn default() -> Self

Returns the “default value” for a type.