Struct PyIterator

#[repr(transparent)]
pub struct PyIterator(PyAny);

A Python iterator object.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyIterator> or Bound<'py, PyIterator>.

Examples

use pyo3::prelude::*;
use pyo3::ffi::c_str;

Python::with_gil(|py| -> PyResult<()> {
    let list = py.eval(c_str!("iter([1, 2, 3, 4])"), None, None)?;
    let numbers: PyResult<Vec<usize>> = list
        .try_iter()?
        .map(|i| i.and_then(|i|i.extract::<usize>()))
        .collect();
    let sum: usize = numbers?.iter().sum();
    assert_eq!(sum, 10);
    Ok(())
})

Tuple Fields

0: PyAny

Implementations

impl PyIterator

pub fn from_object<'py>( obj: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyIterator>>

Builds an iterator for an iterable Python object; the equivalent of calling iter(obj) in Python.

Usually it is more convenient to write obj.iter(), which is a more concise way of calling this function.

pub fn from_bound_object<'py>( obj: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyIterator>>

👎Deprecated since 0.23.0: renamed to PyIterator::from_object

Deprecated name for PyIterator::from_object.

Methods from Deref<Target = PyAny>

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

Trait Implementations

impl AsRef<PyAny> for PyIterator

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyIterator

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeCheck for PyIterator

const NAME: &'static str = "Iterator"

Name of self. This is used in error messages, for example.

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

Checks if object is an instance of Self, which may include a subtype.

impl DerefToPyAny for PyIterator