util

Documentation

Index

• func Bridge[T any](ctx context.Context, chanStream <-chan <-chan T) <-chan T
• func FanIn[T any](ctx context.Context, streams ...<-chan T) <-chan T
• func Or[T any](channels ...<-chan T) <-chan T
• func OrDone[T any](ctx context.Context, c <-chan T) <-chan T
• func Repeat[T any](ctx context.Context, values ...T) <-chan T
• func RepeatFn[T any](ctx context.Context, fn func() T) <-chan T
• func Shuffle[T any](ctx context.Context, in chan T, targetDistance int) <-chan T
• func Take[T any](ctx context.Context, valueStream <-chan T, num int) <-chan T
• func Tee[T any](ctx context.Context, in <-chan T) (_, _ <-chan T)
• type SzError
  • func WrapError(err error, messagef string, msgArgs ...any) SzError
  • func (err SzError) Error() string

Functions

func Bridge

func Bridge[T any](ctx context.Context, chanStream <-chan <-chan T) <-chan T

Bridge joins transforms a series of channels into a single channel

func FanIn

func FanIn[T any](ctx context.Context, streams ...<-chan T) <-chan T

FanIn joins several channels into one

func Or

func Or[T any](channels ...<-chan T) <-chan T

Or returns a channel that combines all the specified channels.

func OrDone

func OrDone[T any](ctx context.Context, c <-chan T) <-chan T

OrDone encapsulates the for-select idiom used for many goroutines the idea is that it makes the code easier to read

func Repeat

func Repeat[T any](ctx context.Context, values ...T) <-chan T

generator that repeats over and over the values it is given

func RepeatFn

func RepeatFn[T any](ctx context.Context, fn func() T) <-chan T

generator that repeats over and over the values it is given

func Shuffle

func Shuffle[T any](ctx context.Context, in chan T, targetDistance int) <-chan T

Shuffle items coming through a channel. input a channel of items to be shuffled. output a channel of shuffled items. target distance is how, on average, far each item should move. there's no guarantee that a particular item will move that far, but it is used as general guidance. Beware: This function incurs a 1μs per item performance hit.

func Take

func Take[T any](ctx context.Context, valueStream <-chan T, num int) <-chan T

generator that takes the specified number of elements from a stream

func Tee

func Tee[T any](ctx context.Context, in <-chan T) (_, _ <-chan T)

Tee takes one channel of objects and splits it into two channels, duplicating the channels. Much like the `tee` tool in *nix

Types

type SzError

type SzError struct {
	Inner      error
	Message    string
	StackTrace string
	Misc       map[string]any
}

func WrapError

func WrapError(err error, messagef string, msgArgs ...any) SzError

func (SzError) Error

func (err SzError) Error() string