Struct CancellableDeadline 

pub struct CancellableDeadline { /* private fields */ }

A deadline that can also be cancelled before it expires.

Pass Self::deadline wherever a query deadline is accepted. Call Self::cancel from any thread to stop the query at its next check point; it then fails exactly as if its deadline had passed. Dropping the handle forgets the cancellation.

Implementations

impl CancellableDeadline

pub fn new(timeout: Option<Duration>) -> CancellableDeadline

A deadline timeout from now (or effectively never when None) that can be cancelled early.

pub fn deadline(&self) -> Instant

pub fn cancel(&mut self)

Request cancellation. Idempotent.

pub fn is_cancelled(&self) -> bool

Trait Implementations

impl Debug for CancellableDeadline

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

Formats the value using the given formatter.

impl Drop for CancellableDeadline

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.