Skip to main content

IngressQueue

Struct IngressQueue 

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

Bounded command queue for the ingress pipeline.

Accepts batches of commands via submit(), assigns monotonic arrival sequence numbers, and produces a sorted, TTL-filtered batch via drain().

Implementations§

Source§

impl IngressQueue

Source

pub fn new(capacity: usize) -> Self

Create a new queue with the given capacity.

§Panics

Panics if capacity is zero.

Source

pub fn submit( &mut self, commands: Vec<Command>, tick_disabled: bool, ) -> Vec<Receipt>

Submit a batch of commands to the queue.

Returns one Receipt per input command. Commands are accepted in order until the queue is full; remaining commands receive QueueFull receipts. If tick_disabled is true, all commands are rejected with TickDisabled.

Arrival sequence numbers are assigned from a monotonic counter that persists across submit calls, overwriting whatever value the caller may have set on Command::arrival_seq.

Source

pub fn drain(&mut self, current_tick: TickId) -> DrainResult

Drain the queue, filtering expired commands and sorting the rest.

A command is expired if cmd.expires_after_tick < current_tick. A command with expires_after_tick == current_tick is valid during that tick.

Returns a DrainResult containing the sorted valid commands and receipts for expired commands.

Source

pub fn len(&self) -> usize

Number of commands currently buffered.

Source

pub fn is_empty(&self) -> bool

Whether the queue is empty.

Source

pub fn capacity(&self) -> usize

Maximum number of commands this queue can hold.

Source

pub fn clear(&mut self)

Discard all pending commands.

Called during TickEngine::reset() so stale commands from previous ticks don’t survive a reset.

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