Struct CancelOnDrop 

pub struct CancelOnDrop(/* private fields */);

Cancels execution on drop and supports cooperative finalization.

If dropped, it will set the cancelled flag to true.

This is most useful when a spawned job should stop once its owner goes away, e.g. a payload job or a blocking RPC call whose caller disconnected.

Implementations

impl CancelOnDrop

pub fn is_interrupted(&self) -> bool

Returns true if the current work should be interrupted.

pub fn is_cancelled(&self) -> bool

Returns true if the job was cancelled.

pub fn request_finalization(&self)

Requests that the current work be finalized without cancelling it.

pub fn is_finalization_requested(&self) -> bool

Returns true if finalization was requested.

pub fn scope<R>(&self, f: impl FnOnce() -> R) -> R

Runs f with this as the cancellation state of the current thread, see is_cancelled.

This lets code deep inside f, such as a loop over transactions, observe cancellation without threading the CancelOnDrop through every call. The previous state of the thread is restored once f returns or unwinds. Leaving the scope does not cancel.

Trait Implementations

impl Clone for CancelOnDrop

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 CancelOnDrop

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

Formats the value using the given formatter.

impl Default for CancelOnDrop

fn default() -> Self

Returns the “default value” for a type.

impl Drop for CancelOnDrop

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 #130494)

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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes