supporting

Documentation

Index

• Variables
• func AdaptError(err error, exitCode int) *cli.ExitError
• func AdaptErrorWithMessage(err error, msg string, exitCode int) *cli.ExitError
• func AddrOf[T any](value T) *T
• func ArrayEqual[T comparable](this, that []T) bool
• func Contains[I comparable](collection []I, item I) bool
• func ContainsWithMatcher[I any](collection []I, matcher func(other I) bool) bool
• func DistinctItems[V any](items []V, identityFn func(item V) string) []V
• func Filter[I any](collection []I, filter func(item I) bool) []I
• func FilterMap[K, V comparable](source map[K]V, filter func(key K, value V) bool) map[K]V
• func IndexOf[I comparable](collection []I, item I) int
• func IndexOfWithMatcher[I any](collection []I, matcher func(other I) bool) int
• func Map[E, R any](elements []E, mapper func(element E) R) []R
• func MapMapper[K comparable, V, R any](elements map[K]V, mapper func(key K, element V) R) []R
• func MapWithIterator[E, R any](iterator Iterator[E], mapper func(element E) R) []R
• func Min[T Numbers](i, o T) T
• func RandomNumber(min, max int) int
• func RandomTextString(length int) string
• func Sort[I any](collection []I, less func(this, other I) bool)
• type Channel
  • func NewChannel[T any](size int) *Channel[T]
  • func (c *Channel[T]) Close()
  • func (c *Channel[T]) Read() T
  • func (c *Channel[T]) ReadChannel() <-chan T
  • func (c *Channel[T]) Write(value T)
• type Iterator
• type MultiShutdownAwaiter
  • func NewMultiShutdownAwaiter(slots uint) *MultiShutdownAwaiter
  • func (msa *MultiShutdownAwaiter) AwaitDone()
  • func (msa *MultiShutdownAwaiter) AwaitShutdown(slot uint) error
  • func (msa *MultiShutdownAwaiter) AwaitShutdownChan(slot uint) <-chan bool
  • func (msa *MultiShutdownAwaiter) SignalDone()
  • func (msa *MultiShutdownAwaiter) SignalShutdown()
• type Numbers
• type Queue
  • func NewQueue[E any]() *Queue[E]
  • func (rq *Queue[E]) Lock()
  • func (rq *Queue[E]) Pop() E
  • func (rq *Queue[E]) Push(fn E) bool
• type ShutdownAwaiter
  • func NewShutdownAwaiter() *ShutdownAwaiter
  • func (sa *ShutdownAwaiter) AwaitDone() error
  • func (sa *ShutdownAwaiter) AwaitShutdown() error
  • func (sa *ShutdownAwaiter) AwaitShutdownChan() <-chan bool
  • func (sa *ShutdownAwaiter) SignalDone()
  • func (sa *ShutdownAwaiter) SignalShutdown()
• type Waiter
  • func NewWaiter() *Waiter
  • func NewWaiterWithTimeout(timeout time.Duration) *Waiter
  • func (w *Waiter) Await() error
  • func (w *Waiter) Reset()
  • func (w *Waiter) Signal()

Variables

var ErrWaiterTimeout = fmt.Errorf("waiter timed out")

Functions

func AdaptError

func AdaptError(err error, exitCode int) *cli.ExitError

func AdaptErrorWithMessage

func AdaptErrorWithMessage(err error, msg string, exitCode int) *cli.ExitError

func AddrOf

func AddrOf[T any](value T) *T

func ArrayEqual

func ArrayEqual[T comparable](this, that []T) bool

func Contains

func Contains[I comparable](collection []I, item I) bool

func ContainsWithMatcher

func ContainsWithMatcher[I any](collection []I, matcher func(other I) bool) bool

func DistinctItems

func DistinctItems[V any](items []V, identityFn func(item V) string) []V

func Filter

func Filter[I any](collection []I, filter func(item I) bool) []I

func FilterMap

func FilterMap[K, V comparable](source map[K]V, filter func(key K, value V) bool) map[K]V

func IndexOf

func IndexOf[I comparable](collection []I, item I) int

func IndexOfWithMatcher

func IndexOfWithMatcher[I any](collection []I, matcher func(other I) bool) int

func Map

func Map[E, R any](elements []E, mapper func(element E) R) []R

func MapMapper

func MapMapper[K comparable, V, R any](elements map[K]V, mapper func(key K, element V) R) []R

func MapWithIterator

func MapWithIterator[E, R any](iterator Iterator[E], mapper func(element E) R) []R

func Min

func Min[T Numbers](i, o T) T

func RandomNumber

func RandomNumber(min, max int) int

func RandomTextString

func RandomTextString(length int) string

func Sort

func Sort[I any](collection []I, less func(this, other I) bool)

Types

type Channel

type Channel[T any] struct {
	// contains filtered or unexported fields
}

Channel is based on https://github.com/jtarchie/ringbuffer, but extended with the option to skip waiting on an empty output channel

func NewChannel

func NewChannel[T any](size int) *Channel[T]

func (*Channel[T]) Close

func (c *Channel[T]) Close()

func (*Channel[T]) Read

func (c *Channel[T]) Read() T

func (*Channel[T]) ReadChannel

func (c *Channel[T]) ReadChannel() <-chan T

func (*Channel[T]) Write

func (c *Channel[T]) Write(value T)

type Iterator

type Iterator[E any] func() (E, bool)

type MultiShutdownAwaiter

type MultiShutdownAwaiter struct {
	// contains filtered or unexported fields
}

func NewMultiShutdownAwaiter

func NewMultiShutdownAwaiter(slots uint) *MultiShutdownAwaiter

func (*MultiShutdownAwaiter) AwaitDone

func (msa *MultiShutdownAwaiter) AwaitDone()

func (*MultiShutdownAwaiter) AwaitShutdown

func (msa *MultiShutdownAwaiter) AwaitShutdown(slot uint) error

func (*MultiShutdownAwaiter) AwaitShutdownChan

func (msa *MultiShutdownAwaiter) AwaitShutdownChan(slot uint) <-chan bool

func (*MultiShutdownAwaiter) SignalDone

func (msa *MultiShutdownAwaiter) SignalDone()

func (*MultiShutdownAwaiter) SignalShutdown

func (msa *MultiShutdownAwaiter) SignalShutdown()

type Numbers

type Numbers interface {
	int | int8 | int16 | int32 | int64 | uint | uint8 | uint16 | uint32 | uint64
}

type Queue

type Queue[E any] struct {
	// contains filtered or unexported fields
}

func NewQueue

func NewQueue[E any]() *Queue[E]

func (*Queue[E]) Lock

func (rq *Queue[E]) Lock()

func (*Queue[E]) Pop

func (rq *Queue[E]) Pop() E

func (*Queue[E]) Push

func (rq *Queue[E]) Push(fn E) bool

type ShutdownAwaiter

type ShutdownAwaiter struct {
	// contains filtered or unexported fields
}

func NewShutdownAwaiter

func NewShutdownAwaiter() *ShutdownAwaiter

func (*ShutdownAwaiter) AwaitDone

func (sa *ShutdownAwaiter) AwaitDone() error

func (*ShutdownAwaiter) AwaitShutdown

func (sa *ShutdownAwaiter) AwaitShutdown() error

func (*ShutdownAwaiter) AwaitShutdownChan

func (sa *ShutdownAwaiter) AwaitShutdownChan() <-chan bool

func (*ShutdownAwaiter) SignalDone

func (sa *ShutdownAwaiter) SignalDone()

func (*ShutdownAwaiter) SignalShutdown

func (sa *ShutdownAwaiter) SignalShutdown()

type Waiter

type Waiter struct {
	// contains filtered or unexported fields
}

func NewWaiter

func NewWaiter() *Waiter

func NewWaiterWithTimeout

func NewWaiterWithTimeout(timeout time.Duration) *Waiter

func (*Waiter) Await

func (w *Waiter) Await() error

func (*Waiter) Reset

func (w *Waiter) Reset()

func (*Waiter) Signal

func (w *Waiter) Signal()