Struct veloren_common_assets::AnyCache
pub struct AnyCache<'a> {
cache: &'a dyn Cache,
}Expand description
A non-generic version of [AssetCache].
For most purposes, this can be used exactly like an AssetCache: you can
load assets from it.
Unlike AssetCache this type is not generic, which is useful to make nicer
APIs.
Fields§
§cache: &'a dyn CacheImplementations§
§impl<'a> AnyCache<'a>
impl<'a> AnyCache<'a>
pub fn raw_source(self) -> impl Source + 'a
pub fn raw_source(self) -> impl Source + 'a
The Source from which assets are loaded.
pub fn load<T>(self, id: &str) -> Result<&'a Handle<T>, Error>where
T: Compound,
pub fn load<T>(self, id: &str) -> Result<&'a Handle<T>, Error>where
T: Compound,
Loads an asset.
If the asset is not found in the cache, it is loaded from the source.
Errors
Errors for Assets can occur in several cases :
- The source could not be read
- Loaded data could not be converted properly
- The asset has no extension
pub fn load_expect<T>(self, id: &str) -> &'a Handle<T>where
T: Compound,
pub fn load_expect<T>(self, id: &str) -> &'a Handle<T>where
T: Compound,
pub fn get_cached<T>(self, id: &str) -> Option<&'a Handle<T>>where
T: Storable,
pub fn get_cached<T>(self, id: &str) -> Option<&'a Handle<T>>where
T: Storable,
Gets a value from the cache.
The value does not have to be an asset, but if it is not, its type must
be marked with the [Storable] trait.
This function does not attempt to load the value from the source if it is not found in the cache.
pub fn get_or_insert<T>(self, id: &str, default: T) -> &'a Handle<T>where
T: Storable,
pub fn get_or_insert<T>(self, id: &str, default: T) -> &'a Handle<T>where
T: Storable,
Gets a value from the cache or inserts one.
As for get_cached, non-assets types must be marked with [Storable].
Assets added via this function will never be reloaded.
pub fn contains<T>(self, id: &str) -> boolwhere
T: Storable,
pub fn contains<T>(self, id: &str) -> boolwhere
T: Storable,
Returns true if the cache contains the specified asset.
pub fn load_dir<T>(self, id: &str) -> Result<&'a Handle<Directory<T>>, Error>where
T: DirLoadable,
pub fn load_dir<T>(self, id: &str) -> Result<&'a Handle<Directory<T>>, Error>where
T: DirLoadable,
Loads a directory.
The directory’s id is constructed the same way as assets. To specify
the cache’s root, give the empty string ("") as id.
Note that this function only gets the ids of assets, and that are not actually loaded. The returned handle can be use to iterate over them.
Errors
An error is returned if the given id does not match a valid readable directory.
pub fn load_rec_dir<T>(
self,
id: &str
) -> Result<&'a Handle<RecursiveDirectory<T>>, Error>where
T: DirLoadable,
pub fn load_rec_dir<T>(
self,
id: &str
) -> Result<&'a Handle<RecursiveDirectory<T>>, Error>where
T: DirLoadable,
Loads a directory and its subdirectories.
The directory’s id is constructed the same way as assets. To specify
the cache’s root, give the empty string ("") as id.
Note that this function only gets the ids of assets, and that are not actually loaded. The returned handle can be use to iterate over them.
Errors
An error is returned if the given id does not match a valid readable directory.
When loading a directory recursively, directories that can’t be read are ignored.
pub fn load_owned<T>(self, id: &str) -> Result<T, Error>where
T: Compound,
pub fn load_owned<T>(self, id: &str) -> Result<T, Error>where
T: Compound,
Loads an owned version of an asset.
Note that the asset will not be fetched from the cache nor will it be
cached. In addition, hot-reloading does not affect the returned value
(if used during Compound::load. It will still be registered as a
dependency).
This can be useful if you need ownership on a non-clonable value.
pub fn no_record<T, F>(self, f: F) -> Twhere
F: FnOnce() -> T,
pub fn no_record<T, F>(self, f: F) -> Twhere
F: FnOnce() -> T,
Temporarily prevent Compound dependencies to be recorded.
This function disables dependencies recording in Compound::load.
Assets loaded during the given closure will not be recorded as
dependencies and the currently loading asset will not be reloaded when
they are.
When hot-reloading is disabled or if the cache’s Source does not
support hot-reloading, this function only returns the result of the
closure given as parameter.
pub fn is_hot_reloaded(self) -> bool
pub fn is_hot_reloaded(self) -> bool
Returns true if values stored in this cache may be hot-reloaded.
Trait Implementations§
§impl<'a> AsAnyCache<'a> for AnyCache<'a>
impl<'a> AsAnyCache<'a> for AnyCache<'a>
§fn as_any_cache(&self) -> AnyCache<'a>
fn as_any_cache(&self) -> AnyCache<'a>
AnyCache.