Struct audio_streams::AudioBuffer

pub(crate) struct AudioBuffer<'a> {
    pub(crate) buffer: &'a mut [u8],
    pub(crate) offset: usize,
    pub(crate) frame_size: usize,
}

AudioBuffer is one buffer that holds buffer_size audio frames. It is the inner data of PlaybackBuffer and CaptureBuffer.

Fields

buffer: &'a mut [u8]

offset: usize

frame_size: usize

Implementations

impl<'a> AudioBuffer<'a>

pub fn frame_capacity(&self) -> usize

Returns the number of audio frames that fit in the buffer.

pub(crate) fn calc_len(&self, size: usize) -> usize

pub fn write_copy_cb<F: FnOnce(&mut [u8])>( &mut self, size: usize, cb: F ) -> Result<usize>

Writes up to size bytes directly to this buffer inside of the given callback function.

pub fn read_copy_cb<F: FnOnce(&[u8])>( &mut self, size: usize, cb: F ) -> Result<usize>

Reads up to size bytes directly from this buffer inside of the given callback function.

pub fn copy_from(&mut self, reader: &mut dyn Read) -> Result<usize>

Copy data from an io::Reader

pub fn copy_to(&mut self, writer: &mut dyn Write) -> Result<usize>

Copy data to an io::Write

Trait Implementations

impl<'a> Read for AudioBuffer<'a>

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

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>

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

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

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

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

Read 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)

Read 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<'a> Write for AudioBuffer<'a>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.