Struct pyo3_async::asyncio::AsyncGenerator

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

Python async generator wrapping a PyStream.

Implementations

impl AsyncGenerator

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

Wrap a boxed stream in to a Python async generator.

If throw callback is provided:

• async generator athrow method will call it with the passed exception before polling;
• async generator aclose method will call it with None before polling and dropping the stream. If throw callback is not provided, the stream will dropped without additional poll.

pub fn from_stream(stream: impl PyStream + 'static) -> Self

Wrap a generic stream.

Trait Implementations

impl IntoPy<Py<PyAny>> for AsyncGenerator

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

Performs the conversion.

impl PyClass for AsyncGenerator

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AsyncGenerator

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<AsyncGenerator>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<AsyncGenerator>

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 AsyncGenerator

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

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

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

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

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

impl PyMethods<AsyncGenerator> for PyClassImplCollector<AsyncGenerator>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for AsyncGenerator

type AsRefTarget = PyCell<AsyncGenerator>

Utility type to make Py::as_ref work.

const NAME: &'static str = "AsyncGenerator"

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.