Skip to main content

DispatchQueue

Struct DispatchQueue 

Source
pub struct DispatchQueue<T> { /* private fields */ }
Expand description

Deterministic FIFO dispatch queue for attempt coordination.

§Invariants

  • Intake is bounded to capacity.
  • Dequeue order is deterministic FIFO.
  • Shutdown state is explicit and inspectable.
  • This type does not apply execution or retry policy.

Implementations§

Source§

impl<T> DispatchQueue<T>

Source

pub fn new(capacity: NonZeroUsize) -> Self

Creates a dispatch queue with bounded intake capacity.

Source

pub fn enqueue(&mut self, item: T) -> Result<(), DispatchQueueError>

Enqueues one work item.

Returns:

Source

pub fn dequeue(&mut self) -> Result<Option<T>, DispatchQueueError>

Dequeues one work item in deterministic FIFO order.

Returns DispatchQueueError::Shutdown only when the dispatch queue has been shut down and no queued work remains.

Source

pub fn shutdown(&mut self)

Marks the dispatch queue as shut down.

After shutdown:

  • New intake is rejected.
  • Existing queued items remain available to be drained in FIFO order.
Source

pub fn capacity(&self) -> usize

Returns queue capacity.

Source

pub fn len(&self) -> usize

Returns queued item count.

Source

pub fn is_empty(&self) -> bool

Returns true when no items are queued.

Source

pub fn is_shutdown(&self) -> bool

Returns true when dispatch queue has been marked shut down.

Trait Implementations§

Source§

impl<T: Debug> Debug for DispatchQueue<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for DispatchQueue<T>

§

impl<T> RefUnwindSafe for DispatchQueue<T>
where T: RefUnwindSafe,

§

impl<T> Send for DispatchQueue<T>
where T: Send,

§

impl<T> Sync for DispatchQueue<T>
where T: Sync,

§

impl<T> Unpin for DispatchQueue<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for DispatchQueue<T>

§

impl<T> UnwindSafe for DispatchQueue<T>
where T: UnwindSafe,

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.