Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

iterator

package

Go to main page

Versions in this module

v1

v1.20.7

Dec 31, 2025

v1.20.6

Dec 31, 2025

v1.20.5

Dec 30, 2025

v1.20.4

Dec 30, 2025

v1.20.3

Dec 30, 2025

v1.20.2

Dec 29, 2025

v1.20.1

Dec 29, 2025

v1.20.0

Dec 28, 2025

Changes in this version

+ func CmpBy[T any, U any](a Iterator[T], b Iterator[U], cmp func(T, U) int) constraints.Ordering

+ func Cmp[T constraints.Ord](a Iterator[T], b Iterator[T]) constraints.Ordering

+ func DefaultSizeHint[T any]() (uint, option.Option[uint])

+ func EqBy[T any, U any](a Iterator[T], b Iterator[U], eq func(T, U) bool) bool

+ func Eq[T comparable](a Iterator[T], b Iterator[T]) bool

+ func FindMap[T any, U any](iter Iterator[T], f func(T) option.Option[U]) option.Option[U]

+ func Fold[T any, B any](iter Iterator[T], init B, f func(B, T) B) B

+ func Ge[T constraints.Digit](a Iterator[T], b Iterator[T]) bool

+ func Gt[T constraints.Digit](a Iterator[T], b Iterator[T]) bool

+ func IsSortedByKey[T any, K constraints.Digit](iter Iterator[T], f func(T) K) bool

+ func IsSortedBy[T any](iter Iterator[T], compare func(T, T) bool) bool

+ func IsSorted[T constraints.Digit](iter Iterator[T]) bool

+ func Le[T constraints.Digit](a Iterator[T], b Iterator[T]) bool

+ func Lt[T constraints.Digit](a Iterator[T], b Iterator[T]) bool

+ func MaxByKey[T any, K constraints.Ord](iter Iterator[T], f func(T) K) option.Option[T]

+ func Max[T constraints.Ord](iter Iterator[T]) option.Option[T]

+ func MinByKey[T any, K constraints.Ord](iter Iterator[T], f func(T) K) option.Option[T]

+ func Min[T constraints.Ord](iter Iterator[T]) option.Option[T]

+ func Ne[T comparable](a Iterator[T], b Iterator[T]) bool

+ func PartialCmpBy[T any, U any](a Iterator[T], b Iterator[U], ...) option.Option[constraints.Ordering]

+ func PartialCmp[T constraints.Digit](a Iterator[T], b Iterator[T]) option.Option[constraints.Ordering]

+ func Product[T constraints.Digit](iter Iterator[T]) T

+ func Pull2[K any, V any](it Iterator[pair.Pair[K, V]]) (next func() (K, V, bool), stop func())

+ func Rfind[T any](de DoubleEndedIterator[T], predicate func(T) bool) option.Option[T]

+ func Rfold[T any, B any](de DoubleEndedIterator[T], init B, f func(B, T) B) B

+ func Seq2[K any, V any](it Iterator[pair.Pair[K, V]]) iter.Seq2[K, V]

+ func Sum[T constraints.Digit](iter Iterator[T]) T

+ func TryFold[T any, B any](iter Iterator[T], init B, f func(B, T) result.Result[B]) result.Result[B]

+ func TryForEach[T any, B any](iter Iterator[T], f func(T) result.Result[B]) result.Result[B]

+ func TryRfold[T any, B any](de DoubleEndedIterator[T], init B, f func(B, T) result.Result[B]) result.Result[B]

+ func Unzip[T any, U any](iter Iterator[pair.Pair[T, U]]) ([]T, []U)

+ type BitSetLike interface

+ Get func(offset int) bool

+ Size func() int

+ type ChunkResult struct

+ func (r ChunkResult[T]) IsErr() bool

+ func (r ChunkResult[T]) IsOk() bool

+ func (r ChunkResult[T]) Unwrap() T

+ func (r ChunkResult[T]) UnwrapErr() T

+ type DoubleEndedIterable interface

+ NextBack func() option.Option[T]

+ type DoubleEndedIterator struct

+ func (de DoubleEndedIterator[T]) AdvanceBackBy(n uint) result.VoidResult

+ func (de DoubleEndedIterator[T]) NextBack() option.Option[T]

+ func (de DoubleEndedIterator[T]) NthBack(n uint) option.Option[T]

+ func (de DoubleEndedIterator[T]) Remaining() uint

+ func (de DoubleEndedIterator[T]) Rfind(predicate func(T) bool) option.Option[T]

+ func (de DoubleEndedIterator[T]) Rfold(init T, f func(T, T) T) T

+ func (de DoubleEndedIterator[T]) TryRfold(init T, f func(T, T) result.Result[T]) result.Result[T]

+ func (de DoubleEndedIterator[T]) XRfold(init any, f func(any, T) any) any

+ func (de DoubleEndedIterator[T]) XTryRfold(init any, f func(any, T) result.Result[any]) result.Result[any]

+ type Iterable interface

+ Next func() option.Option[T]

+ SizeHint func() (uint, option.Option[uint])

+ type IterableCount interface

+ Count func() uint

+ type IterableSizeHint interface

+ SizeHint func() (uint, option.Option[uint])

+ type Iterator struct

+ func ArrayChunks[T any](iter Iterator[T], chunkSize uint) Iterator[[]T]

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

+ func Cloned[T any](iter Iterator[*T]) Iterator[T]

+ func Empty[T any]() Iterator[T]

+ func Enumerate[T any](iter Iterator[T]) Iterator[pair.Pair[uint, T]]

+ func FilterMap[T any, U any](iter Iterator[T], f func(T) option.Option[U]) Iterator[U]

+ func FlatMap[T any, U any](iter Iterator[T], f func(T) Iterator[U]) Iterator[U]

+ func Flatten[T any](iter Iterator[Iterator[T]]) Iterator[T]

+ func FromBitSet(bitset BitSetLike) Iterator[pair.Pair[int, bool]]

+ func FromBitSetBytes(bytes []byte) Iterator[pair.Pair[int, bool]]

+ func FromBitSetBytesOnes(bytes []byte) Iterator[int]

+ func FromBitSetBytesZeros(bytes []byte) Iterator[int]

+ func FromBitSetOnes(bitset BitSetLike) Iterator[int]

+ func FromBitSetZeros(bitset BitSetLike) Iterator[int]

+ func FromElements[T any](elems ...T) Iterator[T]

+ func FromFunc[T any](f func() option.Option[T]) Iterator[T]

+ func FromIterable[T any](data Iterable[T]) Iterator[T]

+ func FromPull2[K any, V any](next func() (K, V, bool), stop func()) (Iterator[pair.Pair[K, V]], func())

+ func FromPull[T any](next func() (T, bool), stop func()) (Iterator[T], func())

+ func FromRange[T constraints.Integer](start T, end T) Iterator[T]

+ func FromSeq2[K any, V any](seq iter.Seq2[K, V]) (Iterator[pair.Pair[K, V]], func())

+ func FromSeq[T any](seq iter.Seq[T]) (Iterator[T], func())

+ func FromSlice[T any](slice []T) Iterator[T]

+ func MapWhile[T any, U any](iter Iterator[T], predicate func(T) option.Option[U]) Iterator[U]

+ func MapWindows[T any, U any](iter Iterator[T], windowSize uint, f func([]T) U) Iterator[U]

+ func Map[T any, U any](iter Iterator[T], f func(T) U) Iterator[U]

+ func Once[T any](value T) Iterator[T]

+ func OptMap[T any, U any](iter Iterator[T], f func(T) *U) Iterator[option.Option[*U]]

+ func Repeat[T any](value T) Iterator[T]

+ func RetMap[T any, U any](iter Iterator[T], f func(T) (U, error)) Iterator[result.Result[U]]

+ func Scan[T any, U any, St any](iter Iterator[T], initialState St, f func(*St, T) option.Option[U]) Iterator[U]

+ func Zip[T any, U any](a Iterator[T], b Iterator[U]) Iterator[pair.Pair[T, U]]

+ func (it Iterator[T]) AdvanceBy(n uint) result.VoidResult

+ func (it Iterator[T]) All(predicate func(T) bool) bool

+ func (it Iterator[T]) Any(predicate func(T) bool) bool

+ func (it Iterator[T]) Chain(other Iterator[T]) Iterator[T]

+ func (it Iterator[T]) Collect() []T

+ func (it Iterator[T]) Count() uint

+ func (it Iterator[T]) Cycle() Iterator[T]

+ func (it Iterator[T]) Filter(predicate func(T) bool) Iterator[T]

+ func (it Iterator[T]) FilterMap(f func(T) option.Option[T]) Iterator[T]

+ func (it Iterator[T]) Find(predicate func(T) bool) option.Option[T]

+ func (it Iterator[T]) FindMap(f func(T) option.Option[T]) option.Option[T]

+ func (it Iterator[T]) FlatMap(f func(T) Iterator[T]) Iterator[T]

+ func (it Iterator[T]) Fold(init T, f func(T, T) T) T

+ func (it Iterator[T]) ForEach(f func(T))

+ func (it Iterator[T]) Fuse() Iterator[T]

+ func (it Iterator[T]) Inspect(f func(T)) Iterator[T]

+ func (it Iterator[T]) Intersperse(separator T) Iterator[T]

+ func (it Iterator[T]) IntersperseWith(separator func() T) Iterator[T]

+ func (it Iterator[T]) Last() option.Option[T]

+ func (it Iterator[T]) Map(f func(T) T) Iterator[T]

+ func (it Iterator[T]) MapWhile(predicate func(T) option.Option[T]) Iterator[T]

+ func (it Iterator[T]) MapWindows(windowSize uint, f func([]T) T) Iterator[T]

+ func (it Iterator[T]) MaxBy(compare func(T, T) int) option.Option[T]

+ func (it Iterator[T]) MinBy(compare func(T, T) int) option.Option[T]

+ func (it Iterator[T]) MustToDoubleEnded() DoubleEndedIterator[T]

+ func (it Iterator[T]) Next() option.Option[T]

+ func (it Iterator[T]) NextChunk(n uint) ChunkResult[[]T]

+ func (it Iterator[T]) Nth(n uint) option.Option[T]

+ func (it Iterator[T]) Partition(f func(T) bool) (truePart []T, falsePart []T)

+ func (it Iterator[T]) Peekable() PeekableIterator[T]

+ func (it Iterator[T]) Position(predicate func(T) bool) option.Option[uint]

+ func (it Iterator[T]) Pull() (next func() (T, bool), stop func())

+ func (it Iterator[T]) Pull2() (next func() (uint, T, bool), stop func())

+ func (it Iterator[T]) Reduce(f func(T, T) T) option.Option[T]

+ func (it Iterator[T]) Scan(initialState T, f func(*T, T) option.Option[T]) Iterator[T]

+ func (it Iterator[T]) Seq() iter.Seq[T]

+ func (it Iterator[T]) Seq2() iter.Seq2[uint, T]

+ func (it Iterator[T]) SizeHint() (uint, option.Option[uint])

+ func (it Iterator[T]) Skip(n uint) Iterator[T]

+ func (it Iterator[T]) SkipWhile(predicate func(T) bool) Iterator[T]

+ func (it Iterator[T]) StepBy(step uint) Iterator[T]

+ func (it Iterator[T]) Take(n uint) Iterator[T]

+ func (it Iterator[T]) TakeWhile(predicate func(T) bool) Iterator[T]

+ func (it Iterator[T]) TryFind(f func(T) result.Result[bool]) result.Result[option.Option[T]]

+ func (it Iterator[T]) TryFold(init T, f func(T, T) result.Result[T]) result.Result[T]

+ func (it Iterator[T]) TryForEach(f func(T) result.Result[T]) result.Result[T]

+ func (it Iterator[T]) TryReduce(f func(T, T) result.Result[T]) result.Result[option.Option[T]]

+ func (it Iterator[T]) TryToDoubleEnded() option.Option[DoubleEndedIterator[T]]

+ func (it Iterator[T]) XFilterMap(f func(T) option.Option[any]) Iterator[any]

+ func (it Iterator[T]) XFindMap(f func(T) option.Option[any]) option.Option[any]

+ func (it Iterator[T]) XFlatMap(f func(T) Iterator[any]) Iterator[any]

+ func (it Iterator[T]) XFold(init any, f func(any, T) any) any

+ func (it Iterator[T]) XMap(f func(T) any) Iterator[any]

+ func (it Iterator[T]) XMapWhile(predicate func(T) option.Option[any]) Iterator[any]

+ func (it Iterator[T]) XMapWindows(windowSize uint, f func([]T) any) Iterator[any]

+ func (it Iterator[T]) XScan(initialState any, f func(*any, T) option.Option[any]) Iterator[any]

+ func (it Iterator[T]) XTryFold(init any, f func(any, T) result.Result[any]) result.Result[any]

+ func (it Iterator[T]) XTryForEach(f func(T) result.Result[any]) result.Result[any]

+ type PeekableIterator struct

+ func (p *PeekableIterator[T]) Next() option.Option[T]

+ func (p *PeekableIterator[T]) Peek() option.Option[T]

+ func (p *PeekableIterator[T]) SizeHint() (uint, option.Option[uint])

+ type SizeIterable interface

+ Remaining func() uint