Struct IngressQueueRef 

pub struct IngressQueueRef(/* private fields */);

Cheap-clone handle to the shared IngressQueue surfaced by crate::node::Node::ingress_handle. Behaves identically to Arc<IngressQueue> via Deref so callers can .push(IngressEvent::...) directly. The newtype wrapper isolates the public API from the underlying smart-pointer choice.

Implementations

impl IngressQueueRef

pub fn new(queue: Arc<IngressQueue>) -> Self

Wrap an existing Arc<IngressQueue>. Used by Node after borrowing from the inner engine.

impl IngressQueueRef

pub fn arc(&self) -> &Arc<IngressQueue>

Borrow the underlying Arc<IngressQueue>. Used by transport adapters and in-process test buses that need to share the queue across threads — both pin a per-Node queue handle and push events as the transport receives them.

Methods from Deref<Target = IngressQueue>

pub fn completion_result_cap(&self) -> usize

Per-complete() result-byte cap. Defaults to usize::MAX when not configured; apply_config_caps reseeds it from NodeConfig::max_completion_result_bytes.

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

Push an event. On success returns Ok(()) and wakes the engine if it’s sleeping. On a full queue the event comes back in Err(_) and the dropped_overflow counter is incremented; transport adapters decide whether to retry, drop with a metric, or escalate as back-pressure. The IngressEvent Err variant is large (carries a WireEnvelope with multihash PeerIds); transport adapters already box or re-queue, so the cost lives at the boundary.

pub fn drain_all(&self) -> Vec<IngressEvent>

Drain all available events. Called by the engine on each poll cycle’s ingress drain.

Pre-reserves capacity for the bounded queue’s full length so the drain Vec grows once at construction, not in O(log n) reallocations as events pop. The queue itself caps inflight at self.capacity(); the drain is bounded by the same cap, so the upfront reservation is the exact-fit answer.

pub fn register_waker(&self, waker: &Waker)

Register the engine’s waker so future pushes can wake it.

pub fn is_empty(&self) -> bool

true when the queue currently holds no events.

pub fn len(&self) -> usize

Approximate current queue depth. The underlying concurrent-queue returns an approximate len for the MPMC case; introspection callers should treat this as a snapshot, not a real-time invariant.

pub fn capacity(&self) -> usize

Bounded capacity supplied at construction. concurrent-queue guarantees Some(cap) for bounded queues, so unwrapping is safe for the framework’s path that never builds an unbounded ingress queue.

pub fn dropped_overflow(&self) -> u64

Total events dropped due to the queue being full since this queue was constructed. Telemetry hook for transport adapters

• Node introspection.

Trait Implementations

impl Clone for IngressQueueRef

fn clone(&self) -> IngressQueueRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IngressQueueRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for IngressQueueRef

type Target = IngressQueue

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.