EventRingBuffer

Struct EventRingBuffer 

Source
pub struct EventRingBuffer<E: Event + Copy> { /* private fields */ }
Expand description

Lock-free ring buffer for event storage

Optimized for Single-Producer-Single-Consumer (SPSC) pattern with atomic head/tail pointers for wait-free operations.

§Thread Safety

This buffer is designed for SPSC (Single-Producer-Single-Consumer) use. While it is Send + Sync, concurrent multi-producer or multi-consumer access may lead to data races or lost events. For MPSC patterns, use external synchronization or the ShardedEventBus which provides isolation through sharding.

§Memory Ordering

  • Producer writes data before publishing tail (Release)
  • Consumer reads head with Acquire before accessing data
  • This ensures data visibility across threads in SPSC mode

Implementations§

Source§

impl<E: Event + Copy> EventRingBuffer<E>

Source

pub fn new(capacity: usize) -> Self

Create new ring buffer with specified capacity

Capacity must be power of 2 for efficient modulo operations.

Source

pub fn push(&self, event: E) -> Result<(), E>

Push event to buffer

Returns Err(event) if buffer is full. Time complexity: O(1), typically <100ns

Source

pub fn pop(&self) -> Option<E>

Pop event from buffer

Returns None if buffer is empty. Time complexity: O(1), typically <100ns

Source

pub fn len(&self) -> usize

Get current number of events in buffer

Source

pub fn is_empty(&self) -> bool

Check if buffer is empty

Source

pub fn is_full(&self) -> bool

Check if buffer is full

Source

pub fn capacity(&self) -> usize

Get buffer capacity

Source

pub fn fill_ratio(&self) -> f32

Get fill percentage (0.0 to 1.0)

Trait Implementations§

Auto Trait Implementations§

§

impl<E> !Freeze for EventRingBuffer<E>

§

impl<E> !RefUnwindSafe for EventRingBuffer<E>

§

impl<E> Unpin for EventRingBuffer<E>
where E: Unpin,

§

impl<E> UnwindSafe for EventRingBuffer<E>
where E: 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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