luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve PyIterator docs a little

This commit is contained in:
Georg Brandl 2020-09-11 18:51:57 +02:00 committed by David Hewitt
parent 15b0e19266
commit 70a3785383
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/types/iterator.rs
View File

@ -9,6 +9,10 @@ use crate::{ffi, AsPyPointer, PyAny, PyErr, PyNativeType, PyResult, Python};
/// Unlike other Python objects, this class includes a `Python<'p>` token
/// so that `PyIterator` can implement the Rust `Iterator` trait.
///
/// This means that you can't use `PyIterator` in many places where other
/// types like `PyList` can automatically be extracted from objects, such
/// as function arguments.
///
/// # Example
///
/// ```rust
@ -29,7 +33,9 @@ use crate::{ffi, AsPyPointer, PyAny, PyErr, PyNativeType, PyResult, Python};
pub struct PyIterator<'p>(&'p PyAny);
impl<'p> PyIterator<'p> {
/// Constructs a `PyIterator` from a Python iterator object.
/// Constructs a `PyIterator` from a Python iterable object.
///
/// Equivalent to Python's built-in `iter` function.
pub fn from_object<T>(py: Python<'p>, obj: &T) -> PyResult<PyIterator<'p>>
where
T: AsPyPointer,