Struct nrf_modem::CancellationToken

pub struct CancellationToken { /* private fields */ }

A token you can pass to certain async functions that let you cancel them.

This can be nice for example when you have a task that is ‘stuck’ receiving data that never arrives, but you want it to stop doing that so it can continue doing something else.

Implementations

impl CancellationToken

pub const fn new() -> Self

Create a new token

pub fn cancel(&self)

Set the token to cancel the operation that uses this token.

This may not cancel the task immediately because that may not always be possible.

pub fn is_cancelled(&self) -> bool

Returns whether or not the cancel function has been called already

pub fn restore(&self)

Restore the token to the non-cancelled state. This can be used so you can reuse the same token multiple times.

Calling this may prevent a cancellation, but the cancellation may have already started.

Trait Implementations

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.