Struct pyo3_async::sniffio::Coroutine

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

Python coroutine wrapping a PyFuture.

Implementations

impl Coroutine

pub fn new(future: Pin<Box<dyn PyFuture>>, throw: Option<ThrowCallback>) -> Self

Wrap a boxed future in to a Python coroutine.

If throw callback is provided:

• coroutine throw method will call it with the passed exception before polling;
• coroutine close method will call it with None before polling and dropping the future. If throw callback is not provided, the future will dropped without additional poll.

pub fn from_future(future: impl PyFuture + 'static) -> Self

Wrap a generic future into a Python coroutine.

Trait Implementations

impl IntoPy<Py<PyAny>> for Coroutine

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

Performs the conversion.

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 Layout = PyCell<Coroutine>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<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<isize>

fn weaklist_offset() -> Option<isize>

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

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

fn extract(obj: &'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: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyMethods<Coroutine> for PyClassImplCollector<Coroutine>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Coroutine

type AsRefTarget = PyCell<Coroutine>

Utility type to make Py::as_ref work.

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

Returns the safe abstraction over the type object.

fn is_type_of(object: &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

Checks if object is an instance of this type.