Skip to main content

StaticRing

Struct StaticRing 

Source
pub struct StaticRing<const N: usize> { /* private fields */ }
Expand description

A fixed-capacity ring buffer storing MessageToken values.

Implementations§

Source§

impl<const N: usize> StaticRing<N>

Source

pub fn new() -> Self

Create a new empty ring.

Trait Implementations§

Source§

impl<const N: usize> Default for StaticRing<N>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const N: usize> Edge for StaticRing<N>

Source§

fn try_push<H: HeaderStore>( &mut self, token: MessageToken, policy: &EdgePolicy, headers: &H, ) -> EnqueueResult

Attempt to push a token onto the queue using the given edge policy. Read more
Source§

fn try_pop<H: HeaderStore>( &mut self, headers: &H, ) -> Result<MessageToken, QueueError>

Attempt to pop the front token from the queue. Read more
Source§

fn occupancy(&self, policy: &EdgePolicy) -> EdgeOccupancy

Return a snapshot of occupancy used for telemetry and admission. Read more
Source§

fn is_empty(&self) -> bool

Return true if the queue is empty.
Source§

fn try_peek(&self) -> Result<MessageToken, QueueError>

Peek at the front token without removing it.
Source§

fn try_peek_at(&self, index: usize) -> Result<MessageToken, QueueError>

Peek at the token at logical position index from the front. Read more
Source§

fn try_pop_batch<H: HeaderStore>( &mut self, policy: &BatchingPolicy, headers: &H, ) -> Result<BatchView<'_, MessageToken>, QueueError>

Pop a batch of tokens according to the provided batching policy. Read more
Source§

fn peek_header<'h, H: HeaderStore>( &self, headers: &'h H, ) -> Result<<H as HeaderStore>::HeaderGuard<'h>, QueueError>

Peek the front message header via HeaderStore (convenience). Read more
Source§

fn get_admission_decision<H: HeaderStore>( &self, policy: &EdgePolicy, token: MessageToken, headers: &H, ) -> AdmissionDecision

Return an AdmissionDecision for the given token according to policy and the current occupancy snapshot. Read more
Source§

fn get_admission_decision_from_message<P: Payload>( &self, policy: &EdgePolicy, message: &Message<P>, ) -> AdmissionDecision

Return an AdmissionDecision for the given token according to policy and the current occupancy snapshot. Read more

Auto Trait Implementations§

§

impl<const N: usize> Freeze for StaticRing<N>

§

impl<const N: usize> RefUnwindSafe for StaticRing<N>

§

impl<const N: usize> Send for StaticRing<N>

§

impl<const N: usize> Sync for StaticRing<N>

§

impl<const N: usize> Unpin for StaticRing<N>

§

impl<const N: usize> UnsafeUnpin for StaticRing<N>

§

impl<const N: usize> UnwindSafe for StaticRing<N>

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.