Struct bones_framework::prelude::AssetServer

pub struct AssetServer {
    pub inner: Arc<AssetServerInner>,
    pub io: Arc<dyn AssetIo>,
}

Struct responsible for loading assets into it’s contained AssetStore, using an AssetIo implementation.

Fields

inner: Arc<AssetServerInner>

The asset server inner state.

io: Arc<dyn AssetIo>

The AssetIo implementation used to load assets.

Implementations

impl AssetServer

pub fn new<Io>(io: Io, version: Version) -> AssetServer

where Io: AssetIo + 'static,

Initialize a new AssetServer.

pub async fn load_asset_bytes( &self, loc: AssetLoc, force: bool, ) -> Result<Cid, Error>

Load the bytes of the asset at the given path, but return only the Cid.

The loaded bytes can be accessed from asset_server.store.asset_data using the Cid.

If force is false, the bytes will be loaded from cache if possible.

pub fn watch_for_changes(&self)

Tell the asset backend to watch for changes and trigger hot reloads for changed assets.

pub fn set_io<Io>(&mut self, io: Io)

where Io: AssetIo + 'static,

Set the AssetIo implementation.

This should almost always be called before calling load_assets().

pub fn handle_asset_changes<F>(&mut self, handle_change: F)

where F: FnMut(&mut AssetServer, UntypedHandle),

Responds to any asset changes reported by the AssetIo implementation.

This must be called or asset changes will be ignored. Additionally, the AssetIo implementation must be able to detect asset changes or this will do nothing.

pub async fn load_assets(&self) -> Result<(), Error>

Load all assets. This is usually done in an async task.

pub async fn load_pack( &self, pack: Option<&str>, ) -> Result<AssetPackSpec, Error>

Load the asset pack with the given folder name, or else the default pack if None.

pub async fn load_core_pack(&self) -> Result<AssetPackSpec, Error>

Load the core asset pack.

pub fn load_asset(&self, loc: AssetLocRef<'_>) -> UntypedHandle

Load an asset.

pub fn load_asset_forced(&self, loc: AssetLocRef<'_>) -> UntypedHandle

Like load_asset() but forces the asset to reload, even it if has already been loaded.

pub fn get_asset_untyped( &self, handle: UntypedHandle, ) -> Option<Ref<'_, Cid, LoadedAsset>>

Borrow a LoadedAsset associated to the given handle.

pub fn get_asset_untyped_mut( &self, handle: UntypedHandle, ) -> Option<RefMut<'_, Cid, LoadedAsset>>

Borrow a LoadedAsset associated to the given handle.

pub fn core(&self) -> MappedMutexGuard<'_, RawMutex, AssetPack>

Read the core asset pack.

Panics

Panics if the assets have not be loaded yet with AssetServer::load_assets.

pub fn root<T>(&self) -> MappedRef<'_, Cid, LoadedAsset, T>

where T: HasSchema,

Get the core asset pack’s root asset.

pub fn untyped_root(&self) -> MappedRef<'_, Cid, LoadedAsset, SchemaBox>

Get the core asset pack’s root asset as a type-erased SchemaBox.

pub fn packs(&self) -> &DashMap<AssetPackSpec, AssetPack>

Read the loaded asset packs.

pub fn get<T>(&self, handle: Handle<T>) -> MappedRef<'_, Cid, LoadedAsset, T>

where T: HasSchema,

Borrow a loaded asset.

Panics

Panics if the asset is not loaded or if the asset asset with the given handle doesn’t have a schema matching T.

pub fn get_untyped( &self, handle: UntypedHandle, ) -> MappedRef<'_, Cid, LoadedAsset, SchemaBox>

Borrow a loaded asset.

Panics

Panics if the asset is not loaded.

pub fn get_untyped_mut( &self, handle: UntypedHandle, ) -> MappedRefMut<'_, Cid, LoadedAsset, SchemaBox>

Borrow a loaded asset.

Panics

Panics if the asset is not loaded.

pub fn try_get<T>( &self, handle: Handle<T>, ) -> Option<Result<MappedRef<'_, Cid, LoadedAsset, T>, SchemaMismatchError>>

where T: HasSchema,

Borrow a loaded asset.

Returns None if asset not found and Some(SchemaMismatchError) if type cast fails.

pub fn try_get_untyped( &self, handle: UntypedHandle, ) -> Option<MappedRef<'_, Cid, LoadedAsset, SchemaBox>>

Borrow a loaded asset.

pub fn try_get_untyped_mut( &self, handle: UntypedHandle, ) -> Option<MappedRefMut<'_, Cid, LoadedAsset, SchemaBox>>

Borrow a loaded asset.

pub fn get_handle_from_cid<T>(&self, cid: &Cid) -> Handle<T>

Get handle of loaded asset from content id Cid.

pub fn get_untyped_handle_from_cid(&self, cid: &Cid) -> UntypedHandle

Get untyped handle of loaded asset from content id Cid.

pub fn try_get_handle_from_cid<T>(&self, cid: &Cid) -> Option<Handle<T>>

Try to get handle of loaded asset from content id Cid.

pub fn try_get_untyped_handle_from_cid( &self, cid: &Cid, ) -> Option<UntypedHandle>

Try to get untyped handle of loaded asset from content id Cid.

pub fn get_mut<T>( &mut self, handle: &Handle<T>, ) -> MappedRefMut<'_, Cid, LoadedAsset, T>

where T: HasSchema,

Mutably borrow a loaded asset.

Panics

Panics if the asset is not loaded or if the asset asset with the given handle doesn’t have a schema matching T.

pub fn game_version(&self) -> Version

Get the game version config, used when making sure asset packs are compatible with this game version.

pub fn set_game_version(&self, version: Version)

Set the game version config, used when making sure asset packs are compatible with this game version.

Trait Implementations

impl AssetServerExt for &mut AssetServer

fn register_default_assets(self) -> Self

Register the default assets from bones_framework.

impl Clone for AssetServer

fn clone(&self) -> AssetServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for AssetServer

fn default() -> AssetServer

Returns the “default value” for a type.

impl Deref for AssetServer

type Target = Arc<AssetServerInner>

The resulting type after dereferencing.

fn deref(&self) -> &<AssetServer as Deref>::Target

Dereferences the value.

impl DerefMut for AssetServer

fn deref_mut(&mut self) -> &mut <AssetServer as Deref>::Target

Mutably dereferences the value.

impl HasSchema for AssetServer

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut