Trait AssetLoader

pub trait AssetLoader:
    Send
    + Sync
    + 'static {
    type Asset: Asset;
    type Settings: Settings + Default + Serialize + for<'a> Deserialize<'a>;
    type Error: Into<Box<dyn Error + Send + Sync + 'static>>;

    // Required method
    fn load(
        &self,
        reader: &mut dyn Reader,
        settings: &Self::Settings,
        load_context: &mut LoadContext<'_>,
    ) -> impl ConditionalSendFuture<Output = Result<Self::Asset, Self::Error>>;

    // Provided method
    fn extensions(&self) -> &[&str] { ... }
}

Loads an Asset from a given byte Reader. This can accept AssetLoader::Settings, which configure how the Asset should be loaded.

This trait is generally used in concert with AssetReader to load assets from a byte source.

For a complementary version of this trait that can save assets, see AssetSaver.

Required Associated Types

type Asset: Asset

The top level Asset loaded by this AssetLoader.

type Settings: Settings + Default + Serialize + for<'a> Deserialize<'a>

The settings type used by this AssetLoader.

type Error: Into<Box<dyn Error + Send + Sync + 'static>>

The type of error which could be encountered by this loader.

Required Methods

fn load( &self, reader: &mut dyn Reader, settings: &Self::Settings, load_context: &mut LoadContext<'_>, ) -> impl ConditionalSendFuture<Output = Result<Self::Asset, Self::Error>>

Asynchronously loads AssetLoader::Asset (and any other labeled assets) from the bytes provided by Reader.

Provided Methods

fn extensions(&self) -> &[&str]

Returns a list of extensions supported by this AssetLoader, without the preceding dot. Note that users of this AssetLoader may choose to load files with a non-matching extension.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl AssetLoader for ()

The () loader should never be called. This implementation exists to make the meta format nicer to work with.

type Asset = ()

type Settings = ()

type Error = Error

async fn load( &self, _reader: &mut dyn Reader, _settings: &Self::Settings, _load_context: &mut LoadContext<'_>, ) -> Result<Self::Asset, Self::Error>

fn extensions(&self) -> &[&str]

Implementors