Struct bevy::asset::io::AssetSourceBuilder

pub struct AssetSourceBuilder {
    pub reader: Option<Box<dyn FnMut() -> Box<dyn ErasedAssetReader> + Sync + Send>>,
    pub writer: Option<Box<dyn FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Sync + Send>>,
    pub watcher: Option<Box<dyn FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Sync + Send>>,
    pub processed_reader: Option<Box<dyn FnMut() -> Box<dyn ErasedAssetReader> + Sync + Send>>,
    pub processed_writer: Option<Box<dyn FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Sync + Send>>,
    pub processed_watcher: Option<Box<dyn FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Sync + Send>>,
    pub watch_warning: Option<&'static str>,
    pub processed_watch_warning: Option<&'static str>,
}

Metadata about an “asset source”, such as how to construct the AssetReader and AssetWriter for the source, and whether or not the source is processed.

Fields

reader: Option<Box<dyn FnMut() -> Box<dyn ErasedAssetReader> + Sync + Send>>

writer: Option<Box<dyn FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Sync + Send>>

watcher: Option<Box<dyn FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Sync + Send>>

processed_reader: Option<Box<dyn FnMut() -> Box<dyn ErasedAssetReader> + Sync + Send>>

processed_writer: Option<Box<dyn FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Sync + Send>>

processed_watcher: Option<Box<dyn FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Sync + Send>>

watch_warning: Option<&'static str>

processed_watch_warning: Option<&'static str>

Implementations

impl AssetSourceBuilder

pub fn build( &mut self, id: AssetSourceId<'static>, watch: bool, watch_processed: bool ) -> Option<AssetSource>

Builds a new AssetSource with the given id. If watch is true, the unprocessed source will watch for changes. If watch_processed is true, the processed source will watch for changes.

pub fn with_reader( self, reader: impl FnMut() -> Box<dyn ErasedAssetReader> + Send + Sync + 'static ) -> AssetSourceBuilder

Will use the given reader function to construct unprocessed AssetReader instances.

Examples found in repository

examples/asset/custom_asset_reader.rs (lines 45-50)

    fn build(&self, app: &mut App) {
        app.register_asset_source(
            AssetSourceId::Default,
            AssetSource::build().with_reader(|| {
                Box::new(CustomAssetReader(
                    // This is the default reader for the current platform
                    AssetSource::get_default_reader("assets".to_string())(),
                ))
            }),
        );
    }

pub fn with_writer( self, writer: impl FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Send + Sync + 'static ) -> AssetSourceBuilder

Will use the given writer function to construct unprocessed AssetWriter instances.

pub fn with_watcher( self, watcher: impl FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Send + Sync + 'static ) -> AssetSourceBuilder

Will use the given watcher function to construct unprocessed AssetWatcher instances.

pub fn with_processed_reader( self, reader: impl FnMut() -> Box<dyn ErasedAssetReader> + Send + Sync + 'static ) -> AssetSourceBuilder

Will use the given reader function to construct processed AssetReader instances.

pub fn with_processed_writer( self, writer: impl FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Send + Sync + 'static ) -> AssetSourceBuilder

Will use the given writer function to construct processed AssetWriter instances.

pub fn with_processed_watcher( self, watcher: impl FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Send + Sync + 'static ) -> AssetSourceBuilder

Will use the given watcher function to construct processed AssetWatcher instances.

pub fn with_watch_warning(self, warning: &'static str) -> AssetSourceBuilder

Enables a warning for the unprocessed source watcher, which will print when watching is enabled and the unprocessed source doesn’t have a watcher.

pub fn with_processed_watch_warning( self, warning: &'static str ) -> AssetSourceBuilder

Enables a warning for the processed source watcher, which will print when watching is enabled and the processed source doesn’t have a watcher.

pub fn platform_default( path: &str, processed_path: Option<&str> ) -> AssetSourceBuilder

Returns a builder containing the “platform default source” for the given path and processed_path. For most platforms, this will use FileAssetReader / FileAssetWriter, but some platforms (such as Android) have their own default readers / writers / watchers.

Examples found in repository

examples/asset/extra_source.rs (line 19)

fn main() {
    App::new()
        // Add an extra asset source with the name "example_files" to
        // AssetSourceBuilders.
        //
        // This must be done before AssetPlugin finalizes building assets.
        .register_asset_source(
            "example_files",
            AssetSourceBuilder::platform_default("examples/asset/files", None),
        )
        // DefaultPlugins contains AssetPlugin so it must be added to our App
        // after inserting our new asset source.
        .add_plugins(DefaultPlugins)
        .add_systems(Startup, setup)
        .run();
}

Trait Implementations

impl Default for AssetSourceBuilder

fn default() -> AssetSourceBuilder

Returns the “default value” for a type.