pub struct ArgIterable<T = PyObjectRef> { /* private fields */ }Expand description
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§
Source§impl<T> ArgIterable<T>
impl<T> ArgIterable<T>
Sourcepub fn iter<'a>(&self, vm: &'a VirtualMachine) -> PyResult<PyIterIter<'a, T>>
pub fn iter<'a>(&self, vm: &'a VirtualMachine) -> PyResult<PyIterIter<'a, T>>
Returns an iterator over this sequence of objects.
This operation may fail if an exception is raised while invoking the
__iter__ method of the iterable object.
Trait Implementations§
Source§impl<T: Traverse> Traverse for ArgIterable<T>
impl<T: Traverse> Traverse for ArgIterable<T>
Source§fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)
fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)
impl
traverse() with caution! Following those guideline so traverse doesn’t cause memory error!: Read moreSource§impl<T> TryFromObject for ArgIterable<T>where
T: TryFromObject,
impl<T> TryFromObject for ArgIterable<T>where
T: TryFromObject,
Source§fn try_from_object(vm: &VirtualMachine, obj: PyObjectRef) -> PyResult<Self>
fn try_from_object(vm: &VirtualMachine, obj: PyObjectRef) -> PyResult<Self>
Attempt to convert a Python object to a value of this type.
Auto Trait Implementations§
impl<T> Freeze for ArgIterable<T>
impl<T = PyObjectRef> !RefUnwindSafe for ArgIterable<T>
impl<T = PyObjectRef> !Send for ArgIterable<T>
impl<T = PyObjectRef> !Sync for ArgIterable<T>
impl<T> Unpin for ArgIterable<T>where
T: Unpin,
impl<T = PyObjectRef> !UnwindSafe for ArgIterable<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FromArgOptional for Twhere
T: TryFromObject,
impl<T> FromArgOptional for Twhere
T: TryFromObject,
Source§impl<T> FromArgs for Twhere
T: TryFromObject,
impl<T> FromArgs for Twhere
T: TryFromObject,
Source§fn arity() -> RangeInclusive<usize>
fn arity() -> RangeInclusive<usize>
The range of positional arguments permitted by the function signature. Read more
Source§fn from_args(
vm: &VirtualMachine,
args: &mut FuncArgs,
) -> Result<T, ArgumentError>
fn from_args( vm: &VirtualMachine, args: &mut FuncArgs, ) -> Result<T, ArgumentError>
Extracts this item from the next argument(s).
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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