Struct jack::RingBufferWriter
[−]
[src]
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).
Methods
impl RingBufferWriter
[src]
fn write_buffer(&mut self, buf: &[u8]) -> usize
[src]
Write data into the ringbuffer. Returns: The number of bytes written, which may range from 0 to buf.len()
fn advance(&mut self, cnt: usize)
[src]
Advance the write pointer. use this after peek_iter or get_vector to advance the buffer pointer.
fn space(&mut self) -> usize
[src]
Return the number of bytes available for writing.
fn get_vector<'a>(&'a mut self) -> (&'a mut [u8], &'a mut [u8])
[src]
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.
fn peek_iter<'a>(&'a mut self) -> Chain<IterMut<'a, u8>, IterMut<'a, u8>>
[src]
Iterator that goes over all the data available to write.
Trait Implementations
impl Send for RingBufferWriter
[src]
impl Write for RingBufferWriter
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more