Struct ArgIterable 

pub struct ArgIterable<T = PyObjectRef> { /* private fields */ }

An iterable Python object.

ArgIterable implements FromArgs so that a built-in function can accept an object that is required to conform to the Python iterator protocol.

ArgIterable can optionally perform type checking and conversions on iterated objects using a generic type parameter that implements TryFromObject.

Implementations

impl<T> ArgIterable<T>

pub fn iter<'a>(&self, vm: &'a VirtualMachine) -> PyResult<PyIterIter<'a, T>>

Returns an iterator over this sequence of objects. See PyIter::iter for why it does not ask how long the iterator is.

This operation may fail if an exception is raised while invoking the __iter__ method of the iterable object.

pub fn iter_sized<'a>( &self, vm: &'a VirtualMachine, ) -> PyResult<PyIterIter<'a, T>>

Self::iter for a caller that fills a sized container from the iterator, the way PySequence_Fast() does.

Trait Implementations

impl<T: Traverse> Traverse for ArgIterable<T>

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

impl traverse() with caution! Following those guideline so traverse doesn’t cause memory error!:

fn clear(&mut self, _out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.

impl<T> TryFromObject for ArgIterable<T>

where T: TryFromObject,

fn try_from_object(vm: &VirtualMachine, obj: PyObjectRef) -> PyResult<Self>

Attempt to convert a Python object to a value of this type.