Struct jack::RingBufferReader

pub struct RingBufferReader { /* private fields */ }

Read end of the ring buffer. Can only be used from one thread (can be different from the write thread).

Implementations

impl RingBufferReader

pub fn get_vector(&self) -> (&[u8], &[u8])

Fill a data structure with a description of the current readable data held in the ringbuffer. This description is returned in a two slices. Two slices are needed because the data to be read may be split across the end of the ringbuffer. The first slice represents the bytes ready to be read. If the second slice is not empty, it is the continuation of the data that ended in the first slices. For convenience, consider using peek_iter instead.

pub fn read_buffer(&mut self, buf: &mut [u8]) -> usize

Read data from the ringbuffer. Returns: the number of bytes read, which may range from 0 to buf.len().

pub fn peek(&self, buf: &mut [u8]) -> usize

Read data from the ringbuffer. Opposed to read_buffer() this function does not move the read pointer. Thus it’s a convenient way to inspect data in the ringbuffer in a continous fashion. The price is that the data is copied into a user provided buffer. For “raw” non-copy inspection of the data in the ringbuffer use get_vector() or peek_iter. Returns: the number of bytes read, which may range from 0 to buf.len()

pub fn advance(&mut self, cnt: usize)

Advance the read pointer. use this after peek/peek_iter or get_vector to advance the buffer pointer.

pub fn space(&self) -> usize

Return the number of bytes available for reading.

pub fn peek_iter(&self) -> Chain<Iter<'_, u8>, Iter<'_, u8>>

Iterator that goes over all the data available to read.

Trait Implementations

impl Drop for RingBufferReader

fn drop(&mut self)

Executes the destructor for this type.

impl Read for RingBufferReader

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, Global>) -> 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 Selfwhere
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 Send for RingBufferReader

impl Sync for RingBufferReader