Struct pyo3::coroutine::Coroutine

pub struct Coroutine {
    name: Option<Py<PyString>>,
    qualname_prefix: Option<&'static str>,
    throw_callback: Option<ThrowCallback>,
    future: Option<Pin<Box<dyn Future<Output = PyResult<PyObject>> + Send>>>,
    waker: Option<Arc<AsyncioWaker>>,
}

Available on crate feature experimental-async only.

Python coroutine wrapping a Future.

Fields

name: Option<Py<PyString>>

qualname_prefix: Option<&'static str>

throw_callback: Option<ThrowCallback>

future: Option<Pin<Box<dyn Future<Output = PyResult<PyObject>> + Send>>>

waker: Option<Arc<AsyncioWaker>>

Implementations

impl Coroutine

impl Coroutine

#[doc(hidden)] pub const _PYO3_DEF: AddClassToModule<Self> = _

impl Coroutine

pub(crate) fn new<F, T, E>( name: Option<Py<PyString>>, qualname_prefix: Option<&'static str>, throw_callback: Option<ThrowCallback>, future: F ) -> Self

where F: Future<Output = Result<T, E>> + Send + 'static, T: IntoPy<PyObject>, E: Into<PyErr>,

Wrap a future into a Python coroutine.

Coroutine send polls the wrapped future, ignoring the value passed (should always be None anyway).

Coroutine throw` drop the wrapped future and reraise the exception passed

fn poll( &mut self, py: Python<'_>, throw: Option<PyObject> ) -> PyResult<PyObject>

impl Coroutine

fn __name__(&self, py: Python<'_>) -> PyResult<Py<PyString>>

fn __qualname__(&self, py: Python<'_>) -> PyResult<Py<PyString>>

fn send( &mut self, py: Python<'_>, _value: &Bound<'_, PyAny> ) -> PyResult<PyObject>

fn throw(&mut self, py: Python<'_>, exc: PyObject) -> PyResult<PyObject>

fn close(&mut self)

fn __await__(self_: Py<Self>) -> Py<Self>

fn __next__(&mut self, py: Python<'_>) -> PyResult<PyObject>

impl Coroutine

unsafe fn __pymethod_get___name____( py: Python<'_>, _slf: *mut PyObject ) -> PyResult<*mut PyObject>

unsafe fn __pymethod_get___qualname____( py: Python<'_>, _slf: *mut PyObject ) -> PyResult<*mut PyObject>

unsafe fn __pymethod_send__<'py>( py: Python<'py>, _slf: *mut PyObject, _args: *const *mut PyObject, _nargs: Py_ssize_t, _kwnames: *mut PyObject ) -> PyResult<*mut PyObject>

unsafe fn __pymethod_throw__<'py>( py: Python<'py>, _slf: *mut PyObject, _args: *const *mut PyObject, _nargs: Py_ssize_t, _kwnames: *mut PyObject ) -> PyResult<*mut PyObject>

unsafe fn __pymethod_close__<'py>( py: Python<'py>, _slf: *mut PyObject ) -> PyResult<*mut PyObject>

unsafe fn __pymethod___await____( py: Python<'_>, _raw_slf: *mut PyObject ) -> PyResult<*mut PyObject>

unsafe fn __pymethod___next____( py: Python<'_>, _raw_slf: *mut PyObject ) -> PyResult<*mut PyObject>

Trait Implementations

impl HasPyGilRef for Coroutine

type AsRefTarget = PyCell<Coroutine>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for Coroutine

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

fn type_output() -> TypeInfo

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as a return value.

impl PyClass for Coroutine

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Coroutine

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Coroutine>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<Py_ssize_t>

fn weaklist_offset() -> Option<Py_ssize_t>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Coroutine

type Holder = Option<PyRef<'py, Coroutine>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Coroutine

type Holder = Option<PyRefMut<'py, Coroutine>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl PyMethods<Coroutine> for PyClassImplCollector<Coroutine>

fn py_methods(self) -> &'static PyClassItems

Available on non-crate feature multiple-pymethods only.

impl PyTypeInfo for Coroutine

const NAME: &'static str = "Coroutine"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for Coroutine