Skip to main content

CommandQueues

Struct CommandQueues 

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

Bounded, priority-aware command queues for a station or gateway shard.

Implementations§

Source§

impl CommandQueues

Source

pub fn new(limits: CommandQueueLimits) -> Self

Creates empty command queues.

Source

pub fn push( &mut self, command: CommandEnvelope, ingress: CommandIngress, ) -> Result<CommandPushOutcome, CommandQueueError>

Pushes a command through the barrier-aware ingress policy.

Source

pub fn release_barrier_buffer(&mut self) -> Result<usize, CommandQueueError>

Moves commands buffered by a barrier back into priority queues.

If a target priority queue is full, the first blocked command and all commands after it remain in the barrier buffer for a later retry.

Source

pub fn clear_barrier_buffer(&mut self) -> usize

Drops commands buffered by a barrier.

Source

pub fn pop_next(&mut self) -> Option<CommandEnvelope>

Pops the next command, preferring high priority.

Source

pub fn ready_len(&self) -> usize

Returns queued command count excluding the barrier buffer.

Source

pub fn barrier_buffer_len(&self) -> usize

Returns command count buffered by an active barrier.

Source

pub fn ready_retained_capacity(&self, priority: CommandPriority) -> usize

Returns slots retained by one ready priority queue.

Source

pub fn total_ready_retained_capacity(&self) -> usize

Returns slots retained across all ready priority queues.

Source

pub fn barrier_buffer_retained_capacity(&self) -> usize

Returns slots retained by the barrier buffer.

Source

pub fn reclaim_retained_capacity(&mut self)

Releases unused retained queue storage without changing queued commands.

Source

pub fn barrier_buffer_capacity(&self) -> usize

Maximum commands retained while a barrier buffers ingress.

The buffer uses the saturating sum of the three ready-queue limits so integrations get a bounded default without a separate hidden capacity.

Source

pub fn total_len(&self) -> usize

Returns total command count including barrier buffer.

Source

pub fn is_empty(&self) -> bool

Returns whether no commands are queued.

Trait Implementations§

Source§

impl Clone for CommandQueues

Source§

fn clone(&self) -> CommandQueues

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandQueues

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.