ziter

Documentation

Index

• func SliceChunksOfSize[T any](items []T, chunkSize int) (chunks [][]T)
• func SliceIterator[T any](items []T) *sliceIterator[T]
• func SliceNChunks[T any](items []T, numChunks int) (chunks [][]T)
• func WithChunksOfSize[T any](items []T, chunkSize int, handler ChunkHandler[T]) (err error)
• func WithNChunks[T any](items []T, numChunks int, handler ChunkHandler[T]) (err error)
• type ChunkHandler
• type IFilter
• type ITransform
• type Iterator
  • func Chunkify[T any](iterator Iterator[T], chunkSize int) Iterator[[]T]
  • func Filter[T any](iterator Iterator[T], filter IFilter[T]) Iterator[T]
  • func Transform[F any, T any](iterator Iterator[F], transformer ITransform[F, T]) Iterator[T]

Functions

func SliceChunksOfSize

func SliceChunksOfSize[T any](items []T, chunkSize int) (chunks [][]T)

Break a slice into multiple slices of the provided size. The last chunk may be smaller than the others.

func SliceIterator

func SliceIterator[T any](items []T) *sliceIterator[T]

func SliceNChunks

func SliceNChunks[T any](items []T, numChunks int) (chunks [][]T)

Break a slice into N slices of approximately equal size. The last chunk may be smaller than the others.

func WithChunksOfSize

func WithChunksOfSize[T any](items []T, chunkSize int, handler ChunkHandler[T]) (err error)

Run the handler on each chunk with a maximum size of chunkSize. The last chunk may be smaller than the others.

func WithNChunks

func WithNChunks[T any](items []T, numChunks int, handler ChunkHandler[T]) (err error)

Run the handler N times with chunks of approximately equal size. The last chunk may be smaller than the others.

Types

type ChunkHandler

type ChunkHandler[T any] func(chunk []T) error

type IFilter

type IFilter[T any] interface {
	Filter(item T) (keep bool, err error)
}

type ITransform

type ITransform[F any, T any] interface {
	Transform(item F) (res T, err error)
}

type Iterator

type Iterator[T any] interface {
	Next() (stillOpen bool)
	Err() (err error)
	Item() (item T)
}

func Chunkify

func Chunkify[T any](iterator Iterator[T], chunkSize int) Iterator[[]T]

Transforms an iterator of T into an iterator of []T, where each chunk has a max size of chunkSize.

func Filter

func Filter[T any](iterator Iterator[T], filter IFilter[T]) Iterator[T]

func Transform

func Transform[F any, T any](iterator Iterator[F], transformer ITransform[F, T]) Iterator[T]