Struct rpos_drv::RingByteBuffer

pub struct RingByteBuffer { /* private fields */ }

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

impl RingByteBuffer

pub fn with_capacity(capacity: usize) -> RingByteBuffer

create a ring buffer with capacity

pub fn len(&self) -> usize

the data in the ring buffer

pub fn capacity(&self) -> usize

the capacity of the ring buffer

pub fn free_space(&self) -> usize

free space in bytes in the ring buffer

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);

pub fn skip_bytes(&mut self, bytes: usize) -> usize

skip bytes

pub fn read_from(&mut self, upstream: &mut impl Read) -> Result<usize>

read data from upstream to fill the ring buffer

Example

let read = buffer.read_from(&mut some_stream).unwrap();
println!("{} bytes read from stream to fill buffer, current length of buffer is: {}", read, buffer.len());

Trait Implementations

impl Clone for RingByteBuffer

fn clone(&self) -> RingByteBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RingByteBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RingByteBuffer> for RingByteBuffer

fn eq(&self, other: &RingByteBuffer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for RingByteBuffer

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 Write for RingByteBuffer

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 Selfwhere
    Self: Sized,

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

impl StructuralPartialEq for RingByteBuffer