chanutil

Documentation

Overview

Package chanutil implements methods for working with channels.

Index

• func Batch[T any](in <-chan T, options ...BatchOption) <-chan []T
• func Merge[T any](ins ...<-chan T) <-chan T
• type BatchOption
  • func WithBatchMaxSize(maxSize int) BatchOption
  • func WithBatchMaxWait(maxWait time.Duration) BatchOption

Functions

func Batch

func Batch[T any](in <-chan T, options ...BatchOption) <-chan []T

Batch returns a new channel that consumes all the items from `in` and batches them together.

func Merge

func Merge[T any](ins ...<-chan T) <-chan T

Merge merges multiple channels together.

Types

type BatchOption

type BatchOption func(cfg *batchConfig)

A BatchOption customizes a batch operation.

func WithBatchMaxSize

func WithBatchMaxSize(maxSize int) BatchOption

WithBatchMaxSize sets the maximum batch size for a Batch operation.

func WithBatchMaxWait

func WithBatchMaxWait(maxWait time.Duration) BatchOption

WithBatchMaxWait sets the maximum wait duration for a Batch operation.