pub enum IterNextOutput<T, U> {
    Yield(T),
    Return(U),
}
👎Deprecated since 0.21.0: Use Option or PyStopIteration instead.
Expand description

Output of __next__ which can either yield the next value in the iteration, or return a value to raise StopIteration in Python.

Usage example:

use pyo3::prelude::*;
use pyo3::iter::IterNextOutput;

#[pyclass]
struct PyClassIter {
    count: usize,
}

#[pymethods]
impl PyClassIter {
    #[new]
    pub fn new() -> Self {
        PyClassIter { count: 0 }
    }

    fn __next__(&mut self) -> IterNextOutput<usize, &'static str> {
        if self.count < 5 {
            self.count += 1;
            // Given an instance `counter`, First five `next(counter)` calls yield 1, 2, 3, 4, 5.
            IterNextOutput::Yield(self.count)
        } else {
            // At the sixth time, we get a `StopIteration` with `'Ended'`.
            //     try:
            //         next(counter)
            //     except StopIteration as e:
            //         assert e.value == 'Ended'
            IterNextOutput::Return("Ended")
        }
    }
}

Variants§

§

Yield(T)

👎Deprecated since 0.21.0: Use Option or PyStopIteration instead.

The value yielded by the iterator.

§

Return(U)

👎Deprecated since 0.21.0: Use Option or PyStopIteration instead.

The StopIteration object.

Auto Trait Implementations§

§

impl<T, U> RefUnwindSafe for IterNextOutput<T, U>

§

impl<T, U> Send for IterNextOutput<T, U>
where T: Send, U: Send,

§

impl<T, U> Sync for IterNextOutput<T, U>
where T: Sync, U: Sync,

§

impl<T, U> Unpin for IterNextOutput<T, U>
where T: Unpin, U: Unpin,

§

impl<T, U> UnwindSafe for IterNextOutput<T, U>
where T: UnwindSafe, U: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Ungil for T
where T: Send,