Skip to main content

NotificationRing

Struct NotificationRing 

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

Lock-free SPSC ring buffer carrying NotificationRef from Ring 0 to Ring 1.

Pre-allocates a power-of-2 sized buffer of NotificationRef slots so that the hot-path push never allocates. Uses UnsafeCell for interior mutability with the SPSC invariant: single writer (Ring 0), single reader (Ring 1).

§Capacity

The capacity is always rounded up to the next power of two. This allows fast index computation via bitmask (pos & mask) instead of modulo.

Implementations§

Source§

impl NotificationRing

Source

pub fn new(capacity: usize) -> Self

Creates a new notification ring with the given capacity.

The capacity is rounded up to the next power of two. Minimum effective capacity is 2.

Source

pub fn push(&self, notif: NotificationRef) -> bool

Pushes a notification into the ring (Ring 0 writer).

Returns true on success, false if the ring is full (backpressure). Zero allocations on the hot path.

Source

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

Pops a notification from the ring (Ring 1 reader).

Returns None if the ring is empty.

Source

pub fn drain_into<F: FnMut(NotificationRef)>(&self, f: F) -> usize

Drains all pending notifications, calling f for each one.

Returns the number of notifications drained.

Source

pub fn len(&self) -> usize

Returns the number of pending (unread) notifications.

Source

pub fn is_empty(&self) -> bool

Returns true if there are no pending notifications.

Source

pub fn capacity(&self) -> usize

Returns the ring capacity.

Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more