core

README

core

Core features of atrico libraries

Documentation

Index

• func CloneWithDefaults[T any](original, defaults T, skip ...string) (result T)
• func ConvertSlice[TI, TO any](input []TI, convert func(in TI) TO) (output []TO)
• func DisplayMultiline(obj StringerMl, params ...any)
• func DisplaySliceAsSeparatedString[T any](values []T, separator string) string
• func DownCastSlice[T any](input []any) (output []T, err error)
• func FdisplayMultiline(writer io.Writer, obj StringerMl, params ...any)
• func GoId() int
• func Must[T any](action func() (T, error)) (result T)
• func Must1[T, P1 any](action func(P1) (T, error), p1 P1) (result T)
• func Must2[T, P1, P2 any](action func(P1, P2) (T, error), p1 P1, p2 P2) (result T)
• func Must3[T, P1, P2, P3 any](action func(P1, P2, P3) (T, error), p1 P1, p2 P2, p3 P3) (result T)
• func Must4[T, P1, P2, P3, P4 any](action func(P1, P2, P3, P4) (T, error), p1 P1, p2 P2, p3 P3, p4 P4) (result T)
• func MustNotError(action func() error)
• func MustNotError1[P1 any](action func(P1) error, p1 P1)
• func MustNotError2[P1, P2 any](action func(P1, P2) error, p1 P1, p2 P2)
• func MustNotError3[P1, P2, P3 any](action func(P1, P2, P3) error, p1 P1, p2 P2, p3 P3)
• func MustNotError4[P1, P2, P3, P4 any](action func(P1, P2, P3, P4) error, p1 P1, p2 P2, p3 P3, p4 P4)
• func ReadBytes(reader io.Reader, buffer []byte) (n int, err error)
• func ReadChannelAsSlice[T any](ch <-chan T) []T
• func ReadChannelAsSliceN[T any](ch <-chan T, maxLen int) []T
• func ReadNBytes(reader io.Reader, count int) (buffer []byte, err error)
• func ReadSequenceAsSlice[T any](seq iter.Seq[T]) []T
• func ReadSequenceAsSliceN[T any](seq iter.Seq[T], maxLen int) []T
• func SliceContains[T comparable](list []T, item T) bool
• func UpCastSlice[T any](input []T) (output []any)
• type CachedValue
  • func NewCachedValue[T any](creator func() T) CachedValue[T]
• type StringFilter
  • func NewFilter(include []string, exclude []string) StringFilter
• type StringerMl
• type UniqueNamesContext
  • func (c *UniqueNamesContext) Unique(name string) (uniqueName string)

Functions

func CloneWithDefaults

func CloneWithDefaults[T any](original, defaults T, skip ...string) (result T)

Clone an object, filling unset fields with defaults

func ConvertSlice

func ConvertSlice[TI, TO any](input []TI, convert func(in TI) TO) (output []TO)

Convert a slice of one type to another

func DisplayMultiline

func DisplayMultiline(obj StringerMl, params ...any)

func DisplaySliceAsSeparatedString

func DisplaySliceAsSeparatedString[T any](values []T, separator string) string

func DownCastSlice

func DownCastSlice[T any](input []any) (output []T, err error)

Down Cast a slice of any type to any

func FdisplayMultiline

func FdisplayMultiline(writer io.Writer, obj StringerMl, params ...any)

func GoId

func GoId() int

Id of go routine Use for debugging only

func Must

func Must[T any](action func() (T, error)) (result T)

Convert error return function into direct return with panic

func Must1

func Must1[T, P1 any](action func(P1) (T, error), p1 P1) (result T)

func Must2

func Must2[T, P1, P2 any](action func(P1, P2) (T, error), p1 P1, p2 P2) (result T)

func Must3

func Must3[T, P1, P2, P3 any](action func(P1, P2, P3) (T, error), p1 P1, p2 P2, p3 P3) (result T)

func Must4

func Must4[T, P1, P2, P3, P4 any](action func(P1, P2, P3, P4) (T, error), p1 P1, p2 P2, p3 P3, p4 P4) (result T)

func MustNotError

func MustNotError(action func() error)

Convert error into panic (no return)

func MustNotError1

func MustNotError1[P1 any](action func(P1) error, p1 P1)

func MustNotError2

func MustNotError2[P1, P2 any](action func(P1, P2) error, p1 P1, p2 P2)

func MustNotError3

func MustNotError3[P1, P2, P3 any](action func(P1, P2, P3) error, p1 P1, p2 P2, p3 P3)

func MustNotError4

func MustNotError4[P1, P2, P3, P4 any](action func(P1, P2, P3, P4) error, p1 P1, p2 P2, p3 P3, p4 P4)

func ReadBytes

func ReadBytes(reader io.Reader, buffer []byte) (n int, err error)

Multiple pass reader Copes with io.Reader giving less bytes than requested

func ReadChannelAsSlice

func ReadChannelAsSlice[T any](ch <-chan T) []T

Read a channel into a slice

func ReadChannelAsSliceN

func ReadChannelAsSliceN[T any](ch <-chan T, maxLen int) []T

Read a channel into a slice Will return no more than maxLen maxlen = -1 means no limit

func ReadNBytes

func ReadNBytes(reader io.Reader, count int) (buffer []byte, err error)

Read an absolute number of bytes from a reader

func ReadSequenceAsSlice

func ReadSequenceAsSlice[T any](seq iter.Seq[T]) []T

Read a sequence into a slice

func ReadSequenceAsSliceN

func ReadSequenceAsSliceN[T any](seq iter.Seq[T], maxLen int) []T

Read a channel into a slice Will return no more than maxLen maxlen = -1 means no limit

func SliceContains

func SliceContains[T comparable](list []T, item T) bool

func UpCastSlice

func UpCastSlice[T any](input []T) (output []any)

Up Cast a slice of any type to any

Types

type CachedValue

type CachedValue[T any] interface {
	GetValue() T
	Reset()
}

func NewCachedValue

func NewCachedValue[T any](creator func() T) CachedValue[T]

type StringFilter

type StringFilter interface {
	// Is this string included (matches filter criteria)
	IsIncluded(item string) bool
	// Filter this slice
	Filter(original []string) (filtered []string)
}

StringFilter strings based on regex include and exclude

var AcceptAllFilter StringFilter = defaultFilter(true)

var RejectAllFilter StringFilter = defaultFilter(false)

func NewFilter

func NewFilter(include []string, exclude []string) StringFilter

type StringerMl

type StringerMl interface {
	// Representation of object as multiple lines
	StringMl(params ...any) iter.Seq[string]
}

Multiline version of Stringer

type UniqueNamesContext

type UniqueNamesContext map[string]int

func (*UniqueNamesContext) Unique

func (c *UniqueNamesContext) Unique(name string) (uniqueName string)