Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A shared, one-shot signal that a request was aborted.

Cloning shares the signal. cancel is one-shot by construction: the reason is stored in a OnceLock, so the first caller wins and later ones observe the same reason. That matters because a deadline and a peer’s cancellation notification can land at the same instant, and whichever the request actually acted on is the one a post-mortem needs to see.

Implementations

impl CancellationToken

pub fn new() -> Self

A token that has not been aborted.

pub fn cancel(&self, reason: AbortReason) -> bool

Aborts, unless something already has.

Wakes every waiter currently registered. Returns whether this call is the one that published the reason, which is what tells a caller racing a deadline against a peer’s notification which of the two the request actually acted on.

pub fn is_cancelled(&self) -> bool

Whether the request was aborted.

pub fn reason(&self) -> Option<&AbortReason>

Why it was aborted, if it was.

pub const fn cancelled(&self) -> Cancelled<'_>

Resolves once the request is aborted.

Never resolves before that, and never resolves twice.

Examples

use protocol_droid::domain::session::{AbortReason, CancellationToken};

let token = CancellationToken::new();
let observer = token.clone();
let signal = token.cancelled();
token.cancel(AbortReason::Expired);
signal.await;
assert!(observer.is_cancelled());

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.