kone.collections/dev.lounres.kone.collections.iterator

Package-level declarations

Types

interface KoneExtendableIterator<Element> : KoneIterator<Element>

Represents a KoneIterator that can add element right after its pointer.

interface KoneExtendableLinearIterator<Element> : KoneLinearIterator<Element> , KoneReversibleExtendableIterator<Element>

Represents KoneLinearIterator and KoneReversibleExtendableIterator at the same time.

KoneIterator

interface KoneIterator<out Element>

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

KoneIteratorBuilder

interface KoneIteratorBuilder<in Element>

Builder interface for constructing KoneIterator instances via KoneIterator.build.

KoneLinearIterator

interface KoneLinearIterator<out Element> : KoneReversibleIterator<Element>

Represents a KoneReversibleIterator over some collection of elements that has permanent order on the elements and permanent indices of the elements.

KoneMutableIterator

interface KoneMutableIterator<Element> : KoneSettableIterator<Element> , KoneExtendableIterator<Element> , KoneRemovableIterator<Element>

Represents a KoneIterator that can add, set, and remove the next element.

KoneMutableLinearIterator

interface KoneMutableLinearIterator<Element> : KoneReversibleMutableIterator<Element> , KoneSettableLinearIterator<Element> , KoneExtendableLinearIterator<Element> , KoneRemovableLinearIterator<Element>

Represents KoneLinearIterator and KoneReversibleMutableIterator at the same time.

KoneRemovableIterator

interface KoneRemovableIterator<out Element> : KoneIterator<Element>

Represents a KoneIterator that can remove the next element if it's present.

KoneRemovableLinearIterator

interface KoneRemovableLinearIterator<out Element> : KoneLinearIterator<Element> , KoneReversibleRemovableIterator<Element>

Represents KoneLinearIterator and KoneReversibleRemovableIterator at the same time.

KoneReversibleExtendableIterator

interface KoneReversibleExtendableIterator<Element> : KoneReversibleIterator<Element> , KoneExtendableIterator<Element>

Represents a KoneReversibleIterator that can add element right after and right before its pointer.

KoneReversibleIterator

interface KoneReversibleIterator<out Element> : KoneIterator<Element>

Represents an KoneIterator that can iterate over the elements in both directions, forward and backward.

KoneReversibleMutableIterator

interface KoneReversibleMutableIterator<Element> : KoneMutableIterator<Element> , KoneReversibleSettableIterator<Element> , KoneReversibleExtendableIterator<Element> , KoneReversibleRemovableIterator<Element>

Represents a KoneReversibleIterator that can add, set, and remove both the next and the previous elements.

KoneReversibleRemovableIterator

interface KoneReversibleRemovableIterator<out Element> : KoneReversibleIterator<Element> , KoneRemovableIterator<Element>

Represents a KoneReversibleIterator that can remove the next and the previous elements if they're present.

KoneReversibleSettableIterator

interface KoneReversibleSettableIterator<Element> : KoneReversibleIterator<Element> , KoneSettableIterator<Element>

Represents a KoneReversibleIterator that can change value of the next element and the previous element if they're present.

KoneSettableIterator

interface KoneSettableIterator<Element> : KoneIterator<Element>

Represents a KoneIterator that can change value of the next element if it's present.

KoneSettableLinearIterator

interface KoneSettableLinearIterator<Element> : KoneLinearIterator<Element> , KoneReversibleSettableIterator<Element>

Represents KoneLinearIterator and KoneReversibleSettableIterator at the same time.

Functions

build

fun <Element> KoneIterator.Companion.build(builder: suspend KoneIteratorBuilder<Element>.() -> Unit): KoneIterator<Element>

Builds a KoneIterator using the provided coroutine-based builder function.

empty

fun <Element> KoneIterator.Companion.empty(): KoneIterator<Element>

Returns an empty KoneIterator.

getAndMoveNext

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

Gets the next element in this iterator, moves forward, and returns the got element.

getAndMovePrevious

fun <Element> KoneReversibleIterator<Element>.getAndMovePrevious(): Element

Gets the previous element, moves backward, and returns the got 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.

yieldAll

suspend fun <Element> KoneIteratorBuilder<Element>.yieldAll(iterable: KoneIterable<Element>)

Yields all elements from the given iterable to the iterator being built.

suspend fun <Element> KoneIteratorBuilder<Element>.yieldAll(sequence: KoneSequence<Element>)

Yields all elements from the given sequence to the iterator being built.