iterator

Documentation

Index

• Variables
• func Split[T any](iter Iterator[T], predicate func(T) bool) (Iterator[T], Iterator[T])
• func Tee[T any](it Iterator[T]) (Iterator[T], Iterator[T])
• type Iterator
  • func Cycle[T any](items ...T) Iterator[T]
  • func Filter[T any](iter Iterator[T], predicate func(T) bool) Iterator[T]
  • func From[T any](source ...T) Iterator[T]
  • func FromSlice[T any](source []T) Iterator[T]
  • func Map[From any, To any](collection Iterator[From], mapper func(it From) To) Iterator[To]

Variables

var ErrIteratorEmpty = errors.New("iterator is empty")

Functions

func Split

func Split[T any](iter Iterator[T], predicate func(T) bool) (Iterator[T], Iterator[T])

Split returns two iterators that split the items of the given iterator using the given predicate. The first iterator will only yield items for which the predicate returns true, while the second iterator will only yield items for which the predicate returns false.

func Tee

func Tee[T any](it Iterator[T]) (Iterator[T], Iterator[T])

Tee returns two iterators that iterate over the same underlying iterator. Both iterators can consume the items independently.

Types

type Iterator

type Iterator[T any] interface {
	// HasNext returns true if the iteration has more elements.
	HasNext() bool

	// Next returns the next element in the iteration. If there are no more
	// elements, it panics with ErrIteratorEmpty.
	Next() T

	// Collect returns a slice containing all the remaining elements in the
	Collect() []T
}

Iterator is an interface that represents an iterator over a collection of elements of type T.

func Cycle

func Cycle[T any](items ...T) Iterator[T]

Cycle returns an iterator that cycles through the given items. The returned iterator will yield the items in the same order as they were given, and will repeat the cycle indefinitely.

func Filter

func Filter[T any](iter Iterator[T], predicate func(T) bool) Iterator[T]

Filter returns an iterator that filters the items of the given iterator using the given predicate. The returned iterator will only yield items for which the predicate returns true.

func From

func From[T any](source ...T) Iterator[T]

From returns an iterator over the given arguments.

func FromSlice

func FromSlice[T any](source []T) Iterator[T]

FromSlice returns an iterator over the given slice.

func Map

func Map[From any, To any](collection Iterator[From], mapper func(it From) To) Iterator[To]

Map calls the provided mapper function once for each element in the given iterator, in order, and constructs a new iterator from the results.