Struct ConcurrentEdge 

pub struct ConcurrentEdge { /* private fields */ }

A thread-safe edge handle. All clones share the same underlying ring buffer.

Use ConcurrentEdge::new(capacity) to create; clone for each worker that needs read or write access. Intended for use in codegen-generated run_scoped() methods as the std-feature replacement for StaticRing<N>.

Implementations

impl ConcurrentEdge

pub fn new(capacity: usize) -> Self

Create a new ring buffer with the given item capacity.

Trait Implementations

impl Clone for ConcurrentEdge

fn clone(&self) -> ConcurrentEdge

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Edge for ConcurrentEdge

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.

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

Attempt to pop the front token from the queue.

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

Return a snapshot of occupancy used for telemetry and admission.

fn is_empty(&self) -> bool

Return true if the queue is empty.

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

Peek at the front token without removing it.

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

Peek at the token at logical position index from the front.

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.

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).

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.

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.

impl ScopedEdge for ConcurrentEdge

Available on crate feature std only.

type Handle<'a> = ConcurrentEdge where Self: 'a

Per-worker handle type. Must implement Edge + Send so it can be moved into a scoped thread and used for stepping.

fn scoped_handle<'a>(&'a self, _kind: EdgeHandleKind) -> Self::Handle<'a>

where Self: 'a,

Create a scoped handle for a worker thread.