Struct bevy_internal::asset::io::gated::GatedReader

pub struct GatedReader<R>
where
    R: AssetReader,
{ /* private fields */ }

A “gated” reader that will prevent asset reads from returning until a given path has been “opened” using GateOpener.

This is built primarily for unit tests.

Implementations

impl<R> GatedReader<R>

where R: AssetReader,

pub fn new(reader: R) -> (GatedReader<R>, GateOpener)

Creates a new GatedReader, which wraps the given reader. Also returns a GateOpener which can be used to open “path gates” for this GatedReader.

Trait Implementations

impl<R> AssetReader for GatedReader<R>

where R: AssetReader,

fn read<'a>( &'a self, path: &'a Path ) -> Pin<Box<dyn Future<Output = Result<Box<dyn AsyncRead + Send + Sync + Unpin + 'a>, AssetReaderError>> + Send + 'a>>

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

fn read_meta<'a>( &'a self, path: &'a Path ) -> Pin<Box<dyn Future<Output = Result<Box<dyn AsyncRead + Send + Sync + Unpin + 'a>, AssetReaderError>> + Send + 'a>>

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

fn read_directory<'a>( &'a self, path: &'a Path ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Stream<Item = PathBuf> + Send + Unpin>, AssetReaderError>> + Send + 'a>>

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

fn is_directory<'a>( &'a self, path: &'a Path ) -> Pin<Box<dyn Future<Output = Result<bool, AssetReaderError>> + Send + 'a>>

Returns true if the provided path points to a directory.

fn read_meta_bytes<'a>( &'a self, path: &'a Path ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, AssetReaderError>> + Send + 'a>>

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<R> Clone for GatedReader<R>

where R: AssetReader + Clone,

fn clone(&self) -> GatedReader<R>

Returns a copy of the value.

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

Performs copy-assignment from source.