# Functions
Chain instantiates a [*ChainIter] that will yield all items in the provided iterators to exhaustion first to last.
Collect consumes an [Iterator] and returns all items within a slice.
CollectResults consumes an [Iterator] with a yield type of [result.Result].
Count instantiates a [*CountIter] that will iterate over 0 and the natural numbers.
Cycle instantiates a [*CycleIter] yielding all items from the provided iterator until exhaustion, and then yields them all over again on repeat.
Drop instantiates a [*DropIter] that will skip the number of items of its wrapped iterator by the provided count.
Drop instantiates an [*EnumerateIter] that yield Pairs of the index of iteration and values for a given iterator.
Exclude instantiates a [*FilterIter] that selectively yields only results that cause the provided function to return `false`.
Exhausted instantiates an [*ExhaustedIter] that will immediately be exhausted (Next will always return a None variant).
Filter instantiates a [*FilterIter] that selectively yields only results that cause the provided function to return `true`.
FilterMap instantiates a [*FilterMapIter] that selectively yields only results that cause the provided function to return `true` with a map operation performed on them.
Find the first occurrence of a value that satisfies the predicate and return that value.
Fold consumes an [Iterator] and returns the final result of applying the accumulator function to each element.
ForEach consumes an [Iterator] and executes callback function on each item.
FromChannel instantiates a [*ChannelIter] that will yield each value from the provided channel.
Lift instantiates a [*LiftIter] that will yield all items in the provided slice.
LiftHashMap instantiates a [*LiftHashMapIter] that will yield all items in the provided map as a [Pair].
LiftHashMapKeys instantiates a [*LiftHashMapKeysIter] that will yield all keys in the provided map.
LiftHashMapValues instantiates a [*LiftHashMapValuesIter] that will yield all keys in the provided map.
Lines instantiates a [*LinesIter] that will yield each line from the provided [io.Reader].
LinesString instantiates a [*LinesStringIter] that behaves like a [*LinesIter] except that it yields strings.
Map instantiates a [*MapIter] that will apply the provided function to each item yielded by the provided [Iterator].
Repeat instantiates a [*RepeatIter] always yield the provided item.
Runes instantiates a [*RunesIter] that will yield a rune on iteration.
Take instantiates a [*TakeIter] that will limit the number of items of its wrapped iterator to a maximum limit.
ToChannel consumes an [Iterator] and returns a channel that will receive all values from the provided [Iterator].
Transform instantiates a [*MapIter] that will apply the provided function to each item yielded by the provided [Iterator].
Zip instantiates a [*ZipIter] yielding a [Pair] containing the result of a call to each provided [Iterator]'s Next.
# Structs
BaseIter is intended to be embedded in other iterators to expose method chaining.
ChainIter iterator, see [Chain].
ChannelIter iterator, see [FromChannel].
CountIter iterator, see [Count].
CycleIter iterator, see [Cycle].
DropIter iterator, see [Drop].
EnumerateIter iterator, see [Enumerate].
ExhaustedIter iterator, see [Exhausted].
FilterIter iterator, see [Filter].
FilterMapIter iterator, see [FilterMap].
LiftHashMapIter iterator, see [LiftHashMap].
LiftHashMapKeysIter iterator, see [LiftHashMapKeys].
LiftHashMapValuesIter iterator, see [LiftHashMapValues].
LiftIter iterator, see [Lift].
LinesIter iterator, see [Lines].
No description provided by the author
MapIter iterator, see [Map].
Pairs of values.
RepeatIter iterator, see [Repeat].
RunesIter iterator, see [Runes].
TakeIter iterator, see [Take].
ZipIter iterator, see [Zip].
# Interfaces
Iterator declares that each Iterator must implement a Next method.