Struct runestick::Iterator

pub struct Iterator { /* fields omitted */ }

An owning iterator.

Implementations

impl Iterator

pub fn from<T>(name: &'static str, iter: T) -> Self where
    T: IteratorTrait, 

Construct a new owning iterator.

The name is only intended to identify the iterator in case of errors.

pub fn from_double_ended<T>(name: &'static str, iter: T) -> Self where
    T: DoubleEndedIteratorTrait, 

Construct a new double-ended owning iterator, with a human-readable name.

The name is only intended to identify the iterator in case of errors.

pub fn empty() -> Self

Creates an iterator that yields nothing.

pub fn once(value: Value) -> Self

Creates an iterator that yields an element exactly once.

pub fn size_hint(&self) -> (usize, Option<usize>)

Get the size hint for the iterator.

pub fn next(&mut self) -> Result<Option<Value>, VmError>

Get the next value out of the iterator.

pub fn next_back(&mut self) -> Result<Option<Value>, VmError>

Get the next back value out of the iterator.

pub fn enumerate(self) -> Self

Enumerate the iterator.

pub fn map(self, map: Function) -> Self

Map the iterator using the given function.

pub fn flat_map(self, map: Function) -> Self

Map and flatten the iterator using the given function.

pub fn filter(self, filter: Function) -> Self

Filter the iterator using the given function.

pub fn find(mut self: Self, find: Function) -> Result<Option<Value>, VmError>

Find the first matching value in the iterator using the given function.

pub fn all(mut self: Self, find: Function) -> Result<bool, VmError>

Test if all entries in the iterator matches the given predicate.

pub fn any(mut self: Self, find: Function) -> Result<bool, VmError>

Test if any entry in the iterator matches the given predicate.

pub fn chain(self, other: Value) -> Result<Self, VmError>

Chain this iterator with another.

pub fn chain_raw(self, other: Self) -> Result<Self, VmError>

Chain this iterator with another.

pub fn rev(self) -> Result<Self, VmError>

Map the iterator using the given function.

pub fn skip(self, n: usize) -> Self

Skip over the given number of elements from the iterator.

pub fn take(self, n: usize) -> Self

Take the given number of elements from the iterator.

pub fn count(&mut self) -> Result<usize, VmError>

Count the number of elements remaining in the iterator.

pub fn peekable(self) -> Self

Create a peekable iterator.

pub fn peek(&mut self) -> Result<Option<Value>, VmError>

Peek the next element if supported.

pub fn collect<T>(mut self: Self) -> Result<Vec<T>, VmError> where
    T: FromValue, 

Collect results from the iterator.

pub fn fold(
    mut self: Self,
    mut accumulator: Value,
    f: Function
) -> Result<Value, VmError>

Integrate over the iterator, using accumulator as the initial value and then forwarding the result of each stage.

pub fn product(self) -> Result<Value, VmError>

Compute the product under the assumption of a homogeonous iterator of type T.

pub fn sum(self) -> Result<Value, VmError>

Compute the sum under the assumption of a homogeonous iterator of type T.

Trait Implementations

impl Debug for Iterator

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Iterator> for Value

pub fn from(value: Iterator) -> Self

Performs the conversion.

impl FromValue for Iterator

pub fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl InstallWith for Iterator

pub fn install_with(_: &mut Module) -> Result<(), ContextError>

Hook to install more things into the module.

impl Named for Iterator

pub const NAME: RawStr

The name of the named thing.

impl ToValue for Iterator

pub fn to_value(self) -> Result<Value, VmError>

Convert into a value.

impl TypeOf for Iterator

pub fn type_hash() -> Hash

Convert into a type hash.

pub fn type_info() -> TypeInfo

Access diagnostical information on the value type.

impl<'a> UnsafeFromValue for &'a Iterator

type Output = *const Iterator

The output type from the unsafe coercion.

type Guard = RawRef

The raw guard returned.

pub fn from_value(value: Value) -> Result<(Self::Output, Self::Guard), VmError>

Convert the given reference using unsafe assumptions to a value.

pub unsafe fn unsafe_coerce(output: Self::Output) -> Self

Coerce the output of an unsafe from value into the final output type.

impl<'a> UnsafeFromValue for &'a mut Iterator

type Output = *mut Iterator

The output type from the unsafe coercion.

type Guard = RawMut

The raw guard returned.

pub fn from_value(value: Value) -> Result<(Self::Output, Self::Guard), VmError>

Convert the given reference using unsafe assumptions to a value.

pub unsafe fn unsafe_coerce(output: Self::Output) -> Self

Coerce the output of an unsafe from value into the final output type.