Enum CancellationGranularity

#[non_exhaustive]
pub enum CancellationGranularity {
    None,
    BetweenOperations,
    Incremental,
}

How finely a provider polls its cancellation token.

Declared per provider and asserted by the conformance suite, so a caller learns the real latency instead of assuming instant cancellation. An honest coarse granularity beats a false fine one.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

The provider never polls; cancellation has no effect once dispatched.

The correct declaration for a provider wrapping an opaque routine that takes no token. It is honest, and it is what lets a caller decide to chunk the work itself.

BetweenOperations

Polled between whole sub-operations, e.g. between tools in a batch.

Latency is bounded by one sub-operation, not by the whole batch.

Incremental

Polled inside the algorithm’s inner loops.

Trait Implementations

impl Clone for CancellationGranularity

fn clone(&self) -> CancellationGranularity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationGranularity

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

Formats the value using the given formatter.

impl Hash for CancellationGranularity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CancellationGranularity

fn eq(&self, other: &CancellationGranularity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CancellationGranularity

impl Eq for CancellationGranularity

impl StructuralPartialEq for CancellationGranularity