Struct RingBuf 

pub struct RingBuf { /* private fields */ }

A fixed sized buffer connected end-to-end.

Examples

use std::io::{Read, Write};

use bytebufrs::RingBuf;

let mut rb = RingBuf::with_capacity(5);

rb.write(&[3, 2, 1]).unwrap();
assert_eq!(rb.len(), 3);

let mut buf = [0u8; 10];
rb.read(&mut buf).unwrap();
assert_eq!(rb.len(), 0);
assert_eq!(buf, [3, 2, 1, 0, 0, 0, 0, 0, 0, 0]);

rb.write(&[4, 5, 6, 7, 8]).unwrap();
assert_eq!(rb.len(), 5);

Implementations

impl RingBuf

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty RingBuf with the specified capacity. The underlying buffer will be of length capacity + 1;

Examples

use bytebufrs::RingBuf;

let mut rb = RingBuf::with_capacity(10);

assert_eq!(rb.capacity(), 10);
assert_eq!(rb.len(), 0);
assert!(rb.is_empty());

pub fn capacity(&self) -> usize

Returns the number of bytes the ring buffer can hold.

use bytebufrs::RingBuf;

let rb = RingBuf::with_capacity(10);
assert_eq!(rb.capacity(), 10);

pub fn clear(&mut self)

Clears the ring buffer, resetting the read and write position to 0.

Examples

use bytebufrs::RingBuf;

let mut rb: RingBuf = vec![0, 1, 2, 3, 4].into();

rb.clear();

assert_eq!(rb.len(), 0);
assert!(rb.is_empty());

pub fn len(&self) -> usize

Returns the number of bytes in the ring buffer, also referred to as its ‘length’.

Examples

use bytebufrs::RingBuf;

let rb: RingBuf = vec![1, 2, 3].into();
assert_eq!(rb.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the ring buffer doesn’t contain any bytes.

Examples

use std::io::Write;

use bytebufrs::RingBuf;

let mut rb = RingBuf::with_capacity(10);
assert!(rb.is_empty());

rb.write(&[0, 1, 2, 3]).unwrap();
assert!(!rb.is_empty());

pub fn advance_read_pos(&mut self, count: usize) -> Result<()>

Advances the read position by count. The read position can’t go past the write position.

Examples

use bytebufrs::RingBuf;

let mut rb: RingBuf = vec![0, 1, 2].into();
assert_eq!(rb.len(), 3);
rb.advance_read_pos(3).unwrap();
assert_eq!(rb.len(), 0);

Trying to set the read position past the write position will fail:

use bytebufrs::RingBuf;

let mut rb = RingBuf::with_capacity(10);
rb.advance_read_pos(1).unwrap(); // Will panic!

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

Reads from the ring buffer without advancing the read position. On success,returns the number of bytes peeked.

Examples

use bytebufrs::RingBuf;

let mut rb: RingBuf = vec![0, 1, 2].into();
assert_eq!(rb.len(), 3);

let mut buf = [0u8; 10];
rb.peek(&mut buf).unwrap();
assert_eq!(buf, [0, 1, 2, 0, 0, 0, 0, 0, 0, 0]);
assert_eq!(rb.len(), 3);

Trait Implementations

impl From<Box<[u8]>> for RingBuf

fn from(s: Box<[u8]>) -> Self

Creates a ring buffer with the given slice as backing buffer. Note that the ring buffer capacity will be 1 byte less then the length of the slice.

Examples

use bytebufrs::RingBuf;

let rb: RingBuf = vec![0u8; 5].into_boxed_slice().into();
assert_eq!(rb.capacity(), 4);

impl From<Vec<u8>> for RingBuf

fn from(s: Vec<u8>) -> Self

Creates a ring buffer from the given vector. The capacity and length of the ring buffer will be equal to the length of the vector i.e. the ring buffer will be full.

Examples

use bytebufrs::RingBuf;

let rb: RingBuf = vec![0, 1, 2, 3, 4].into();
assert_eq!(rb.capacity(), 5);
assert_eq!(rb.len(), 5);
assert!(!rb.is_empty());

impl Read for RingBuf

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>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where 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 RingBuf

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes 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, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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