Struct CancelFlag 

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

A flag a caller sets to stop a long operation between two of its steps.

Only the converters take one, and only because their progress callback is the one piece of Python a conversion runs — so a KeyboardInterrupt out of it is how an interrupt surfaces at all. The callback is a Fn returning nothing, so it cannot report the interrupt itself; the binding sets this flag and the conversion checks it after every report.

Implementations

impl CancelFlag

pub fn new() -> Self

pub fn cancel(&self)

pub fn is_cancelled(&self) -> bool

Trait Implementations

impl Clone for CancelFlag

fn clone(&self) -> CancelFlag

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CancelFlag

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

Formats the value using the given formatter.

impl Default for CancelFlag

fn default() -> CancelFlag

Returns the “default value” for a type.