pub struct JobQueues<K: Ord> { /* private fields */ }Expand description
Deterministic, typed FIFO queues driven only by explicit caller operations.
Implementations§
Source§impl<K: Clone + Ord> JobQueues<K>
impl<K: Clone + Ord> JobQueues<K>
Sourcepub fn new(admission: AdmissionLimit) -> Self
pub fn new(admission: AdmissionLimit) -> Self
Creates empty queues with a lifetime admission limit.
Sourcepub fn remaining_admission(&self) -> usize
pub fn remaining_admission(&self) -> usize
Returns capacity remaining under the lifetime admission bound.
Sourcepub fn enqueue(
&mut self,
class: K,
job: impl FnOnce(&mut Self) + 'static,
) -> Result<JobReceipt, CheckpointError>
pub fn enqueue( &mut self, class: K, job: impl FnOnce(&mut Self) + 'static, ) -> Result<JobReceipt, CheckpointError>
Enqueues one job at the tail of its class FIFO.
Sourcepub fn cancel(&mut self, id: JobId) -> JobReceipt
pub fn cancel(&mut self, id: JobId) -> JobReceipt
Cancels a queued job. Cancellation is idempotent and receipt-bearing.
Sourcepub fn drain(&mut self, class: K, work: WorkLimit) -> DrainReceipt<K>
pub fn drain(&mut self, class: K, work: WorkLimit) -> DrainReceipt<K>
Drains at most work jobs from one class.
Sourcepub fn checkpoint(
&mut self,
class: K,
work: WorkLimit,
) -> Result<CheckpointReceipt<K>, CheckpointError>
pub fn checkpoint( &mut self, class: K, work: WorkLimit, ) -> Result<CheckpointReceipt<K>, CheckpointError>
Drains one class to empty, including jobs enqueued reentrantly into it.
Fails closed if empty cannot be reached within work; unrelated job
classes remain untouched.
Auto Trait Implementations§
impl<K> !RefUnwindSafe for JobQueues<K>
impl<K> !Send for JobQueues<K>
impl<K> !Sync for JobQueues<K>
impl<K> !UnwindSafe for JobQueues<K>
impl<K> Freeze for JobQueues<K>
impl<K> Unpin for JobQueues<K>
impl<K> UnsafeUnpin for JobQueues<K>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more