Struct File

pub struct File<P: AsRef<Path>> { /* private fields */ }

Available on crate feature driver only.

A lazily instantiated local file.

Implementations

impl<P: AsRef<Path>> File<P>

pub fn new(path: P) -> Self

Creates a lazy file object, which will open the target path.

This is infallible as the path is only checked during creation.

Trait Implementations

impl<P: Clone + AsRef<Path>> Clone for File<P>

fn clone(&self) -> File<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: AsRef<Path> + Send + Sync> Compose for File<P>

fn create( &mut self, ) -> Result<AudioStream<Box<dyn MediaSource>>, AudioStreamError>

Create a source synchronously.

fn create_async<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<AudioStream<Box<dyn MediaSource>>, AudioStreamError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a source asynchronously.

fn should_create_async(&self) -> bool

Determines whether this source will be instantiated using create or create_async.

fn aux_metadata<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<AuxMetadata, AudioStreamError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Requests auxiliary metadata which can be accessed without parsing the file.

impl<P: Debug + AsRef<Path>> Debug for File<P>

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

Formats the value using the given formatter.

impl<P: AsRef<Path> + Send + Sync + 'static> From<File<P>> for Input

fn from(val: File<P>) -> Self

Converts to this type from the input type.