Struct rpos_drv::RingByteBuffer
source · pub struct RingByteBuffer { /* private fields */ }
Expand description
A ring byte buffer used to operate byte streams
Example
let mut buffer = rpos_drv::RingByteBuffer::with_capacity(100);
buffer.write(&[0, 1, 2, 3]).unwrap();
assert_eq!(buffer.len(), 4 as usize);
Implementations§
source§impl RingByteBuffer
impl RingByteBuffer
sourcepub fn with_capacity(capacity: usize) -> RingByteBuffer ⓘ
pub fn with_capacity(capacity: usize) -> RingByteBuffer ⓘ
create a ring buffer with capacity
sourcepub fn free_space(&self) -> usize
pub fn free_space(&self) -> usize
free space in bytes in the ring buffer
sourcepub fn current_read_slice(&self) -> &[u8] ⓘ
pub fn current_read_slice(&self) -> &[u8] ⓘ
current read slice
Example
let read_slice = buffer.current_read_slice();
let read = some_stream.write(read_slice).unwrap();
buffer.skip_bytes(read);
sourcepub fn skip_bytes(&mut self, bytes: usize) -> usize
pub fn skip_bytes(&mut self, bytes: usize) -> usize
skip bytes
Trait Implementations§
source§impl Clone for RingByteBuffer
impl Clone for RingByteBuffer
source§impl Debug for RingByteBuffer
impl Debug for RingByteBuffer
source§impl PartialEq<RingByteBuffer> for RingByteBuffer
impl PartialEq<RingByteBuffer> for RingByteBuffer
source§fn eq(&self, other: &RingByteBuffer) -> bool
fn eq(&self, other: &RingByteBuffer) -> bool
source§impl Read for RingByteBuffer
impl Read for RingByteBuffer
source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
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. Read more
1.36.0 · source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · source§fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
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
. Read more1.0.0 · source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
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. Read more
source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
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
. Read more1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moresource§impl Write for RingByteBuffer
impl Write for RingByteBuffer
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