Skip to main content

RingBuffer

Struct RingBuffer 

Source
pub struct RingBuffer<'a, T: Pod + FixedLayout> { /* private fields */ }
Expand description

Fixed-capacity circular buffer overlaid on a byte slice.

  • push always succeeds. When full, overwrites the oldest entry.
  • Use for event journals, audit logs, price history, etc.
  • O(1) push, O(1) read by logical index.

Implementations§

Source§

impl<'a, T: Pod + FixedLayout> RingBuffer<'a, T>

Source

pub fn from_bytes(data: &'a mut [u8]) -> Result<Self, ProgramError>

Overlay a RingBuffer on a mutable byte slice.

Source

pub fn capacity(&self) -> usize

Maximum capacity (number of elements).

Source

pub fn count(&self) -> usize

Current number of elements (may be less than capacity if not yet full).

Source

pub fn push(&mut self, value: T) -> Result<(), ProgramError>

Push an element. If the buffer is full, overwrites the oldest entry.

Source

pub fn get(&self, logical_index: usize) -> Result<T, ProgramError>

Read the element at logical index (0 = oldest still in buffer).

Source

pub fn latest(&self) -> Result<T, ProgramError>

Read the most recently pushed element.

Source

pub fn oldest(&self) -> Result<T, ProgramError>

Read the oldest element.

Source

pub const fn required_bytes(capacity: usize) -> usize

Compute the byte size needed for a RingBuffer with the given capacity.

Auto Trait Implementations§

§

impl<'a, T> Freeze for RingBuffer<'a, T>

§

impl<'a, T> RefUnwindSafe for RingBuffer<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for RingBuffer<'a, T>
where T: Send,

§

impl<'a, T> Sync for RingBuffer<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for RingBuffer<'a, T>
where T: Unpin,

§

impl<'a, T> UnsafeUnpin for RingBuffer<'a, T>

§

impl<'a, T> !UnwindSafe for RingBuffer<'a, T>

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.