Documentation
¶
Overview ¶
Package stateless defines a stateless (pure) iterator, i.e. one that can be iterated over multiple times without side effects, it is threadsafe
Index ¶
- func Ap[V, U any](ma Iterator[U]) func(Iterator[func(U) V]) Iterator[V]
- func Chain[U, V any](f func(U) Iterator[V]) func(Iterator[U]) Iterator[V]
- func Compress[U any](sel Iterator[bool]) func(Iterator[U]) Iterator[U]
- func DropWhile[U any](pred func(U) bool) func(Iterator[U]) Iterator[U]
- func Filter[U any](f func(U) bool) func(ma Iterator[U]) Iterator[U]
- func FilterChain[U, V any](f func(U) O.Option[Iterator[V]]) func(ma Iterator[U]) Iterator[V]
- func FilterMap[U, V any](f func(U) O.Option[V]) func(ma Iterator[U]) Iterator[V]
- func First[U any](mu Iterator[U]) O.Option[U]
- func Fold[U any](m M.Monoid[U]) func(Iterator[U]) U
- func FoldMap[U, V any](m M.Monoid[V]) func(func(U) V) func(ma Iterator[U]) V
- func Last[U any](mu Iterator[U]) O.Option[U]
- func Map[U, V any](f func(U) V) func(ma Iterator[U]) Iterator[V]
- func Monoid[U any]() M.Monoid[Iterator[U]]
- func Reduce[U, V any](f func(V, U) V, initial V) func(Iterator[U]) V
- func Scan[FCT ~func(V, U) V, U, V any](f FCT, initial V) func(ma Iterator[U]) Iterator[V]
- func Take[U any](n int) func(ma Iterator[U]) Iterator[U]
- func ToArray[U any](u Iterator[U]) []U
- func Uniq[A any, K comparable](f func(A) K) func(as Iterator[A]) Iterator[A]
- func Zip[A, B any](fb Iterator[B]) func(Iterator[A]) Iterator[T.Tuple2[A, B]]
- type Iterator
- func Count(start int) Iterator[int]
- func Cycle[U any](ma Iterator[U]) Iterator[U]
- func Empty[U any]() Iterator[U]
- func Flatten[U any](ma Iterator[Iterator[U]]) Iterator[U]
- func From[U any](data ...U) Iterator[U]
- func FromArray[U any](as []U) Iterator[U]
- func FromReflect(val R.Value) Iterator[R.Value]
- func MakeBy[FCT ~func(int) U, U any](f FCT) Iterator[U]
- func MonadAp[V, U any](fab Iterator[func(U) V], ma Iterator[U]) Iterator[V]
- func MonadChain[U, V any](ma Iterator[U], f func(U) Iterator[V]) Iterator[V]
- func MonadMap[U, V any](ma Iterator[U], f func(U) V) Iterator[V]
- func Of[U any](a U) Iterator[U]
- func Repeat[U any](n int, a U) Iterator[U]
- func Replicate[U any](a U) Iterator[U]
- func StrictUniq[A comparable](as Iterator[A]) Iterator[A]
- func ZipWith[FCT ~func(A, B) C, A, B, C any](fa Iterator[A], fb Iterator[B], f FCT) Iterator[C]
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Compress ¶ added in v1.0.13
Compress returns an Iterator that filters elements from a data Iterator returning only those that have a corresponding element in selector Iterator that evaluates to `true`. Stops when either the data or selectors iterator has been exhausted.
func DropWhile ¶ added in v1.0.13
DropWhile creates an Iterator that drops elements from the Iterator as long as the predicate is true; afterwards, returns every element. Note, the Iterator does not produce any output until the predicate first becomes false
func FilterChain ¶ added in v1.0.15
FilterChain filters and transforms the content of an iterator
func FoldMap ¶ added in v1.0.16
FoldMap maps and folds an iterator. Map the iterator passing each value to the iterating function. Then fold the results using the provided Monoid.
Example ¶
src := From("a", "b", "c")
fold := FoldMap[string](S.Monoid)(strings.ToUpper)
fmt.Println(fold(src))
Output: ABC
func Last ¶ added in v1.0.14
Last returns the last item in an iterator if such an item exists Note that the function will consume the Iterator in this call completely, to identify the last element. Do not use this for infinite iterators
func Map ¶
Map transforms an Iterator of type [U] into an Iterator of type [V] via a mapping function
func Scan ¶ added in v1.0.12
Scan takes an Iterator and returns a new Iterator of the same length, where the values of the new Iterator are the result of the application of `f` to the value of the source iterator with the previously accumulated value
Types ¶
type Iterator ¶
Iterator represents a stateless, pure way to iterate over a sequence
func Count ¶ added in v1.0.13
Count creates an Iterator containing a consecutive sequence of integers starting with the provided start value
func Cycle ¶ added in v1.0.13
DropWhile creates an Iterator that drops elements from the Iterator as long as the predicate is true; afterwards, returns every element. Note, the Iterator does not produce any output until the predicate first becomes false
func FromReflect ¶ added in v1.0.20
FromReflect creates an iterator that can iterate over types that define [R.Index] and [R.Len]
func MakeBy ¶
MakeBy returns an Iterator with an infinite number of elements initialized with `f(i)`
func MonadMap ¶
MonadMap transforms an Iterator of type [U] into an Iterator of type [V] via a mapping function
func Repeat ¶ added in v1.0.13
Repeat creates an Iterator containing a value repeated the specified number of times. Alias of Replicate
func Replicate ¶
Replicate creates an Iterator containing a value repeated an infinite number of times.
func StrictUniq ¶ added in v1.0.11
func StrictUniq[A comparable](as Iterator[A]) Iterator[A]
StrictUniq converts an Iterator or arbitrary items into an Iterator or unique items where uniqueness is determined by the built-in uniqueness constraint
Source Files
Directories