Skip to main content

Token

Struct Token 

Source
pub struct Token(/* private fields */);
Expand description

A cooperative cancellation signal.

A token is cheap to clone and every clone observes the same cancellation. Token::child_token derives a token that cancels when its parent does but whose own cancellation stays local, which is how a Run scopes a tool batch’s cancellation beneath its own.

Cancellation is one-way and idempotent: once cancelled, a token stays cancelled and further Token::cancel calls change nothing.

use reef_core::cancel;

let run = cancel::Token::new();
let batch = run.child_token();
assert!(!batch.is_cancelled());

// Cancelling the child leaves the parent running.
batch.cancel();
assert!(batch.is_cancelled());
assert!(!run.is_cancelled());

// Cancelling the parent reaches every descendant.
let sibling = run.child_token();
run.cancel();
assert!(sibling.is_cancelled());

Implementations§

Source§

impl Token

Source

pub fn new() -> Self

Creates a token that has not been cancelled.

Source

pub fn is_cancelled(&self) -> bool

Reports whether cancellation has been requested.

Source

pub fn cancel(&self)

Requests cancellation for this token and every token derived from it.

Source

pub fn child_token(&self) -> Self

Derives a token cancelled by this one but not cancelling it.

Source

pub fn cancelled(&self) -> impl Future<Output = ()> + Send + '_

Completes once cancellation has been requested.

The returned future is anonymous on purpose: naming a concrete future type here would put the underlying implementation back into the public surface that Token exists to keep it out of. Awaiting it is cancel-safe — dropping the future deregisters its waker and observes nothing.

Trait Implementations§

Source§

impl Clone for Token

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Token

Source§

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

Renders the observable state without naming the wrapped type.

Source§

impl Default for Token

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Token

§

impl RefUnwindSafe for Token

§

impl Send for Token

§

impl Sync for Token

§

impl Unpin for Token

§

impl UnsafeUnpin for Token

§

impl UnwindSafe for Token

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.