RingBuffer

Struct RingBuffer 

Source
pub struct RingBuffer { /* private fields */ }
Expand description

A circular ring buffer for streaming data.

When the buffer is full, oldest data is overwritten.

Implementations§

Source§

impl RingBuffer

Source

pub fn new(capacity: usize) -> Self

Create a new ring buffer with the given capacity.

Source

pub const fn len(&self) -> usize

Get the current length of data in the buffer.

Source

pub const fn is_empty(&self) -> bool

Check if the buffer is empty.

Source

pub const fn is_full(&self) -> bool

Check if the buffer is full.

Source

pub const fn capacity(&self) -> usize

Get the capacity of the buffer.

Source

pub fn write(&mut self, data: &[u8])

Write data to the buffer.

If the buffer is full, oldest data is overwritten.

Source

pub fn read_all(&self) -> Vec<u8>

Read all data from the buffer.

This does not consume the data.

Source

pub fn as_string(&self) -> String

Read as a string (lossy UTF-8 conversion).

Source

pub const fn clear(&mut self)

Clear the buffer.

Source

pub fn tail_bytes(&self, n: usize) -> Vec<u8>

Get the last N bytes from the buffer.

Trait Implementations§

Source§

impl Debug for RingBuffer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V