Struct EmbeddedAssetReader

pub struct EmbeddedAssetReader { /* private fields */ }

Struct which can be used to retrieve embedded assets directly without the normal Bevy Handle<T> approach. This is useful for cases where you need an asset outside the Bevy ECS environment.

This is only available when the default-source cargo feature is enabled.

Example usage is below which assumes you have an asset named image.png in your assets folder (which this crate embeds at compile time).

use bevy_embedded_assets::{DataReader, EmbeddedAssetReader};
use std::path::Path;

fn some_bevy_system() {
    let embedded: EmbeddedAssetReader = EmbeddedAssetReader::preloaded();
    let reader: DataReader = embedded.load_path_sync(&Path::new("image.png")).unwrap();
    let image_data: Vec<u8> = reader.0.to_vec();
    // Do what you need with the data
}

Implementations

impl EmbeddedAssetReader

pub fn preloaded() -> Self

Create an EmbeddedAssetReader loaded with all the assets found by the build script.

This ensures the EmbeddedAssetReader has all (embedded) assets loaded and can be used directly without the typical Bevy Handle<T> approach. Retrieve assets directly after calling preloaded with EmbeddedAssetReader::load_path_sync().

pub fn load_path_sync( &self, path: &Path, ) -> Result<DataReader, AssetReaderError>

Get the data from the asset matching the path provided.

Errors

This will returns an error if the path is not known.

Trait Implementations

impl AssetReader for EmbeddedAssetReader

async fn read<'a>( &'a self, path: &'a Path, ) -> Result<impl Reader + 'a, AssetReaderError>

Returns a future to load the full file data at the provided path.

async fn read_meta<'a>( &'a self, path: &'a Path, ) -> Result<impl Reader + 'a, AssetReaderError>

Returns a future to load the full file data at the provided path.

async fn read_directory<'a>( &'a self, path: &'a Path, ) -> Result<Box<PathStream>, AssetReaderError>

Returns an iterator of directory entry names at the provided path.

async fn is_directory<'a>( &'a self, path: &'a Path, ) -> Result<bool, AssetReaderError>

Returns true if the provided path points to a directory.

fn read_meta_bytes<'a>(&'a self, path: &'a Path) -> impl ConditionalSendFuture

Reads asset metadata bytes at the given path into a Vec<u8>. This is a convenience function that wraps AssetReader::read_meta by default.

impl Debug for EmbeddedAssetReader

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

Formats the value using the given formatter.

impl Default for EmbeddedAssetReader

fn default() -> Self

Returns the “default value” for a type.