Struct pyo3::coroutine::cancel::CancelHandle

pub struct CancelHandle(Arc<Mutex<Inner>>);

Available on crate feature experimental-async only.

Helper used to wait and retrieve exception thrown in Coroutine.

Only the last exception thrown can be retrieved.

Tuple Fields

0: Arc<Mutex<Inner>>

Implementations

impl CancelHandle

pub fn new() -> Self

Create a new CoroutineCancel.

pub fn is_cancelled(&self) -> bool

Returns whether the associated coroutine has been cancelled.

pub fn poll_cancelled(&mut self, cx: &mut Context<'_>) -> Poll<PyObject>

Poll to retrieve the exception thrown in the associated coroutine.

pub async fn cancelled(&mut self) -> PyObject

Retrieve the exception thrown in the associated coroutine.

#[doc(hidden)] pub fn throw_callback(&self) -> ThrowCallback

Trait Implementations

impl Debug for CancelHandle

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

Formats the value using the given formatter.

impl Default for CancelHandle

fn default() -> CancelHandle

Returns the “default value” for a type.