Struct tokio_util::sync::DropGuard

pub struct DropGuard {
    pub(super) inner: Option<CancellationToken>,
}

A wrapper for cancellation token which automatically cancels it on drop. It is created using drop_guard method on the CancellationToken.

Fields

inner: Option<CancellationToken>

Implementations

impl DropGuard

pub fn disarm(self) -> CancellationToken

Returns stored cancellation token and removes this drop guard instance (i.e. it will no longer cancel token). Other guards for this 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.