Enum DataSource

pub enum DataSource {
    File {
        path: PathBuf,
        data: Box<dyn FileReader>,
    },
    Memory(Cursor<Vec<u8>>),
    Raw {
        sample_rate: usize,
        channel_count: usize,
        samples: Vec<f32>,
    },
    RawStreaming(Box<dyn RawStreamingDataSource<Item = f32>>),
}

Data source enumeration. Provides unified way of selecting data source for sound buffers. It can be either a file or memory block.

Variants

File

Data source is a file of any supported format.

Fields

path: PathBuf

Path to file.

data: Box<dyn FileReader>

Reader for reading from the source

Memory(Cursor<Vec<u8>>)

Data source is a memory block. Memory block must be in valid format (wav or vorbis/ogg). This variant can be used together with virtual file system.

Raw

Raw samples in interleaved format with specified sample rate and channel count. Can be used for procedural sounds.

Notes

Cannot be used with streaming buffers - it makes no sense to stream data that is already loaded into memory.

Fields

sample_rate: usize

Sample rate, typical values 22050, 44100, 48000, etc.

channel_count: usize

Total amount of channels.

samples: Vec<f32>

Raw samples in interleaved format. Count of samples must be multiple to channel count, otherwise you’ll get error at attempt to use such buffer.

RawStreaming(Box<dyn RawStreamingDataSource<Item = f32>>)

Raw streaming source.

Implementations

impl DataSource

pub async fn from_file<P>( path: P, io: &(dyn ResourceIo + 'static), ) -> Result<DataSource, FileLoadError>

where P: AsRef<Path>,

Tries to create new File data source from given path. May fail if file does not exists.

pub fn from_memory(data: Vec<u8>) -> DataSource

Creates new data source from given memory block. This function does not checks if this is valid source or not. Data source validity will be checked on first use.

pub fn path(&self) -> Option<&Path>

Tries to get a path to external data source.

pub fn path_owned(&self) -> Option<PathBuf>

Tries to get a path to external data source.

Trait Implementations

impl Debug for DataSource

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

Formats the value using the given formatter.

impl Read for DataSource

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Seek for DataSource

fn seek(&mut self, pos: SeekFrom) -> Result<u64, Error>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.