Struct IndexWorkControl 

pub struct IndexWorkControl { /* private fields */ }

Shared cancellation and deadline boundary for one indexing operation.

Implementations

impl IndexWorkControl

pub fn new(cancellation: IndexCancellation, timeout: Option<Duration>) -> Self

Create a work boundary with an optional timeout from one shared start.

pub fn with_deadline(cancellation: IndexCancellation, deadline: Instant) -> Self

Create a work boundary with a caller-selected absolute deadline.

pub fn started_at(&self) -> Instant

Return the common start instant for this operation.

pub fn deadline(&self) -> Option<Instant>

Return the common absolute deadline, when configured.

pub fn worker_ceiling(&self) -> Option<usize>

Return the maximum workers available to each operation stage, when bounded.

pub fn with_worker_ceiling(&self, max_workers: usize) -> Self

Clone this boundary while applying a worker ceiling to every operation stage.

pub fn with_timeout_ceiling(&self, timeout: Duration) -> Self

Clone this boundary while applying a maximum duration from its original start.

pub fn consume_purpose_bytes( &self, limit: u64, bytes: u64, ) -> Result<u64, IndexWorkFailure>

Consume authored-purpose bytes from this operation’s aggregate budget.

Errors

Returns IndexWorkFailure::ResourceLimitExceeded when this read and every prior read through a clone would exceed limit.

pub fn cancel(&self)

Request cooperative cancellation for every clone of this control.

pub const fn cancellation(&self) -> &IndexCancellation

Borrow the exact cancellation signal shared by every operation worker.

pub fn check(&self, stage: IndexWorkStage) -> Result<(), IndexWorkFailure>

Check cancellation and deadline state at one typed work stage.

Errors

Returns IndexWorkFailure::Cancelled when cancellation was requested, or IndexWorkFailure::DeadlineExceeded when the deadline elapsed.

Trait Implementations

impl Clone for IndexWorkControl

fn clone(&self) -> IndexWorkControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexWorkControl

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

Formats the value using the given formatter.