Struct GatedReader

pub struct GatedReader<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: AssetReader> GatedReader<R>

pub fn new(reader: R) -> (Self, 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> AssetReader for GatedReader<R>

async fn read<'a>( &'a self, path: &'a Path, ) -> Result<Box<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<Box<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<Output = Result<Vec<u8>, AssetReaderError>>

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.