Struct DropGuard 

pub struct DropGuard { /* private fields */ }

A wrapper for a CancellationToken which cancels it on drop, created by CancellationToken::drop_guard.

use nuclei::sync::CancellationToken;

let token = CancellationToken::new();
let guard = token.clone().drop_guard();
let still_alive = guard.disarm();
assert!(!token.is_cancelled());
drop(still_alive);
assert!(!token.is_cancelled());

Implementations

impl DropGuard

pub fn token(&self) -> &CancellationToken

Returns a reference to the token this guard wraps.

pub fn disarm(self) -> CancellationToken

Returns the token and disarms this guard: it no longer cancels the token. Other guards of the same token are not affected.

Trait Implementations

impl Debug for DropGuard

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

Formats the value using the given formatter.

impl Drop for DropGuard

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.