kone.collections/dev.lounres.kone.collections.iterables/KoneIterator

KoneIterator

interface KoneIterator<out Element>(source)

Represents an iterator over some elements (maybe even infinite number of elements) in some (maybe temporary) order.

In each moment it has a cursor pointing either between two elements, before the first one, or after the last one. If there are no elements in the collection, the pointer just points nowhere. All operations are made either before or after the cursor with previous or next element correspondingly.

Inheritors

KoneReversibleIterator

KoneSettableIterator

KoneExtendableIterator

KoneRemovableIterator

KoneNoddedSetIterator

Functions

asKotlin

fun <Element> KoneIterator<Element>.asKotlin(): Iterator<Element>

fold

inline fun <E, R> KoneIterator<E>.fold(initial: R, operation: (acc: R, E) -> R): R

foldIndexed

inline fun <E, R> KoneIterator<E>.foldIndexed(initial: R, operation: (index: UInt, acc: R, E) -> R): R

getAndMoveNext

fun <Element> KoneIterator<Element>.getAndMoveNext(): Element

Gets the next element, moves forward, and returns the got element.

getNext

abstract fun getNext(): Element

Returns next element in the order or throws NoFollowingElementInIteratorException if there is no next element.

hasNext

abstract operator fun hasNext(): Boolean

Returns true iff there is next element in the order.

iterator

inline operator fun <E> KoneIterator<E>.iterator(): KoneIterator<E>

moveNext

abstract fun moveNext()

Moves forward bypassing next element or throws NoFollowingElementInIteratorException if there is no next element.

inline operator fun <Element> KoneIterator<Element>.next(): Element

Gets the next element moves forward and returns the got element. It is an operator function to use in for cycles.

reduce

inline fun <E : R, R> KoneIterator<E>.reduce(operation: (acc: R, E) -> R): R

reduceIndexed

inline fun <E : R, R> KoneIterator<E>.reduceIndexed(operation: (index: UInt, acc: R, E) -> R): R

reduceIndexedMaybe

inline fun <E : R, R> KoneIterator<E>.reduceIndexedMaybe(operation: (index: UInt, acc: R, E) -> R): Maybe<R>

reduceIndexedOrNull

inline fun <E : R, R> KoneIterator<E>.reduceIndexedOrNull(operation: (index: UInt, acc: R, E) -> R): R?

reduceMaybe

inline fun <E : R, R> KoneIterator<E>.reduceMaybe(operation: (acc: R, E) -> R): Maybe<R>

reduceOrNull

inline fun <E : R, R> KoneIterator<E>.reduceOrNull(operation: (acc: R, E) -> R): R?

runningFold

inline fun <E, R> KoneIterator<E>.runningFold(initial: R, operation: (acc: R, E) -> R): KoneList<R>

runningFoldIndexed

inline fun <E, R> KoneIterator<E>.runningFoldIndexed(initial: R, operation: (index: UInt, acc: R, E) -> R): KoneList<R>

withIndex

fun <E> KoneIterator<E>.withIndex(): KoneIterator<KoneIndexedValue<E>>