Struct PyIterator 

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

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::attach(|py| -> PyResult<()> {
    let list = py.eval(c"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(())
})

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.try_iter(), which is a more concise way of calling this function.

Trait Implementations

impl PyTypeInfo for PyIterator

const NAME: &'static str = "PyIterator"

👎Deprecated since 0.28.0: prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str>

👎Deprecated since 0.28.0: prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

const TYPE_HINT: TypeHint

Provides the full python type as a type hint.

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

Returns the PyTypeObject instance for this type.

fn is_type_of(obj: &Bound<'_, PyAny>) -> bool

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

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

Returns the safe abstraction over the type object.

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

Checks if object is an instance of this type.

impl DerefToPyAny for PyIterator