Skip to main content

RingBuffer

Struct RingBuffer 

Source
pub struct RingBuffer<T: Copy, const N: usize> { /* private fields */ }
Expand description

Ring buffer for streaming data

Implementations§

Source§

impl<T: Copy, const N: usize> RingBuffer<T, N>

Source

pub fn new(default: T) -> Self

Create a new ring buffer with default-initialized data

Source

pub const fn capacity(&self) -> usize

Get the capacity

Source

pub fn len(&self) -> usize

Get the number of items in the buffer

Source

pub fn is_empty(&self) -> bool

Check if buffer is empty

Source

pub const fn is_full(&self) -> bool

Check if buffer is full

Source

pub fn write(&mut self, item: T) -> Result<()>

Write an item to the buffer

§Errors

Returns error if buffer is full

Source

pub fn read(&mut self) -> Result<T>

Read an item from the buffer

§Errors

Returns error if buffer is empty

Source

pub fn peek(&self) -> Result<T>

Peek at the next item without removing it

Source

pub fn clear(&mut self)

Clear the buffer

Auto Trait Implementations§

§

impl<T, const N: usize> Freeze for RingBuffer<T, N>
where T: Freeze,

§

impl<T, const N: usize> RefUnwindSafe for RingBuffer<T, N>
where T: RefUnwindSafe,

§

impl<T, const N: usize> Send for RingBuffer<T, N>
where T: Send,

§

impl<T, const N: usize> Sync for RingBuffer<T, N>
where T: Sync,

§

impl<T, const N: usize> Unpin for RingBuffer<T, N>
where T: Unpin,

§

impl<T, const N: usize> UnsafeUnpin for RingBuffer<T, N>
where T: UnsafeUnpin,

§

impl<T, const N: usize> UnwindSafe for RingBuffer<T, N>
where T: UnwindSafe,

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.