Struct baffa::stack::Ring

pub struct Ring<T: Sized> { /* fields omitted */ }

Circular version of Buffer

Because Buffer is circular, it always has remaining bytes to write. But care must be taken because without consuming already written bytes, it is easy to over-write as ring buffer always has capacity.

Implementations

impl<S: Sized> Ring<S>

pub const fn new() -> Self

Creates new instance

pub const unsafe fn from_parts(buffer: Buffer<S>, read: usize) -> Self

Creates new instance from parts

pub const fn into_parts(self) -> (Buffer<S>, usize)

Creates new instance from parts

pub const fn len(&self) -> usize

Returns number of available elements

pub const fn is_empty(&self) -> bool

Returns whether buffer is empty.

pub const fn is_full(&self) -> bool

Returns whether buffer is full.

Trait Implementations

impl<S: Sized> Buf for Ring<S>

fn capacity(&self) -> usize

Returns size of the underlying memory in the buffer.

fn len(&self) -> usize

Returns number of elements inside the buffer.

fn iter(&self) -> Iter<Self>

Returns iterator over elements inside the buffer.

fn iter_mut(&mut self) -> IterMut<Self>

Returns mutable iterator over elements inside the buffer.

impl<S: Sized> Index<usize> for Ring<S>

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<S: Sized> IndexMut<usize> for Ring<S>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<S: Sized> ReadBuf for Ring<S>

fn available(&self) -> usize

Returns number of bytes left

unsafe fn consume(&mut self, step: usize)

Moves cursor, considering bytes as consumed.

unsafe fn read(&mut self, ptr: *mut u8, size: usize)

Low level read function, that consumes available bytes up to size.

fn read_slice(&mut self, bytes: &mut [u8]) -> usize

Reads available bytes into slice

impl<S: Sized> WriteBuf for Ring<S>

fn remaining(&self) -> usize

Returns number of bytes left

unsafe fn advance(&mut self, step: usize)

Moves cursor, considering bytes written.

unsafe fn write(&mut self, ptr: *const u8, size: usize)

Low level write method, which copies data from pointer up to size.

fn write_slice(&mut self, bytes: &[u8]) -> usize

Writes supplied slice into the buffer, returning number of written bytes.