Struct jack::RingBufferWriter

pub struct RingBufferWriter { /* fields omitted */ }

Write end of the ring buffer. Can only be used from one thread (can be a different from the read thread).

Implementations

impl RingBufferWriter

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

Write data into the ringbuffer. Returns: The number of bytes written, which may range from 0 to buf.len()

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

Advance the write pointer. use this after peek_iter or get_vector to advance the buffer pointer.

pub fn space(&mut self) -> usize

Return the number of bytes available for writing.

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

Return a pair of slices of the current writable space in the ringbuffer. two slices are needed because the space available for writing may be split across the end of the ringbuffer. consider using peek_iter for convenience.

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

Iterator that goes over all the data available to write.

Trait Implementations

impl Drop for RingBufferWriter

fn drop(&mut self)

Executes the destructor for this type.

impl Write for RingBufferWriter

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

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

impl Send for RingBufferWriter

impl Sync for RingBufferWriter