Struct jack::RingBufferWriter
source · pub struct RingBufferWriter { /* private fields */ }
Expand description
Write end of the ring buffer. Can only be used from one thread (can be a different from the read thread).
Implementations§
source§impl RingBufferWriter
impl RingBufferWriter
sourcepub fn write_buffer(&mut self, buf: &[u8]) -> usize
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()
sourcepub fn advance(&mut self, cnt: usize)
pub fn advance(&mut self, cnt: usize)
Advance the write pointer. use this after peek_iter or get_vector to advance the buffer pointer.
sourcepub fn get_vector(&mut self) -> (&mut [u8], &mut [u8])
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.
Trait Implementations§
source§impl Drop for RingBufferWriter
impl Drop for RingBufferWriter
source§impl Write for RingBufferWriter
impl Write for RingBufferWriter
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
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. Read more