Struct Cancellation 

pub struct Cancellation { /* private fields */ }

A runtime-independent, cooperative cancellation signal.

Clones share a persistent cancellation state. Child signals receive ancestor cancellation, but cancelling a child does not cancel its parent or siblings. Dropping a signal does not request cancellation. Signals neither own tasks nor abort futures; callers decide how to respond and separately await completion.

use base_scheduler::{Cancellation, Cancelled};

let system = Cancellation::new();
let server = system.child();
assert!(server.cancel());
assert_eq!(server.check(), Err(Cancelled));
assert!(!system.is_cancelled());
assert!(system.cancel());

Implementations

impl Cancellation

pub fn new() -> Self

Create an independent, uncancelled signal.

pub const fn never() -> Self

Create a signal which cannot be cancelled and requires no allocation. cancel always returns false and cancelled remains pending forever.

pub const fn is_never(&self) -> bool

Whether this signal can never be cancelled. This is true for Self::never and its clones; its children are independently cancellable. Backends can omit cancellation registration for these signals.

pub fn child(&self) -> Self

Create a signal cancelled by this signal or any of its ancestors. A child of an already-cancelled signal starts cancelled. A child of a never-cancelled signal is an independent, cancellable signal.

pub fn cancel(&self) -> bool

Request cancellation of this signal and all its descendants. Returns true only for the first request on this signal. Repeated requests never escalate. Waiters are woken after the entire family lock is released. Concurrent observers may see propagation in progress, but all descendants are cancelled when this call returns. This does not wait for their work.

pub fn is_cancelled(&self) -> bool

Whether cancellation has been requested.

pub fn check(&self) -> Result<(), Cancelled>

Check for cancellation at an explicit cooperative cancellation point.

pub async fn cancelled(&self)

Wait for cancellation using standard future polling and wakeups. This future is immediately ready if already cancelled. Dropping the wait unregisters its listener without cancelling the signal or other waiters. Listener storage is retained inline in the future, without a separate allocation.

Trait Implementations

impl Clone for Cancellation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Cancellation

fn default() -> Self

Returns the “default value” for a type.

impl<Value> Notify<Value> for Cancellation

fn notify(&self, _value: Value)

Deliver value to this destination. Implementations should return promptly.