helpy

README

go-helpy

go-helpy is a dependency free collection of helper functions that I got tired of reimplementing.

It contains (simple) implementations of:

• Set operations
• math Min/Max
• math Abs
• default value and pointer helpers
• time equality operations and other time helpers
• helpers to convert strings to simple types
• and lots of operations on slices

Documentation

Index

• func Abs[T Number](v T) T
• func Clamp[T Number](value T, lower T, upper T) T
• func DerefOrValue[T any](v *T, defaultVal T) *T
• func Max[T ComparableNumber](v T, vs ...T) T
• func Min[T ComparableNumber](v T, vs ...T) T
• func Pointer[T any](v T) *T
• func ValueOrDefault[T comparable](v T, defaultVal T) T
• type ComparableNumber
• type Number
• type Set
  • func MakeSet[T comparable](vs ...T) Set[T]
  • func ToSet[T comparable](vs []T) Set[T]
  • func (s *Set[T]) Add(v T)
  • func (s Set[T]) Contains(v T) bool
  • func (s Set[T]) Equal(s2 Set[T]) bool
  • func (s Set[T]) Intersect(s2 Set[T]) Set[T]
  • func (s Set[T]) Subtract(s2 Set[T]) Set[T]
  • func (s Set[T]) Union(s2 Set[T]) Set[T]

Functions

func Abs

func Abs[T Number](v T) T

func Clamp

func Clamp[T Number](value T, lower T, upper T) T

Clamp returns value if it's in the range [lower, upper], otherwise the closest boundary of lower and upper. NOTE: if lower > upper, then lower is always returned.

func DerefOrValue

func DerefOrValue[T any](v *T, defaultVal T) *T

DerefOrValue returns v if it is not nil, otherwise returns a pointer to defaultVal.

func Max

func Max[T ComparableNumber](v T, vs ...T) T

Max returns the largest value among v and vs.

func Min

func Min[T ComparableNumber](v T, vs ...T) T

Min returns the smallest element among v and vs.

func Pointer

func Pointer[T any](v T) *T

Pointer returns a pointer to v.

func ValueOrDefault

func ValueOrDefault[T comparable](v T, defaultVal T) T

ValueOrDefault returns v if it isn't the default value of T, and otherwise returns defaultVal.

Types

type ComparableNumber

type ComparableNumber interface {
	~int8 | ~int16 | ~int32 | ~int | ~int64 | ~uint8 | ~uint16 | ~uint32 | ~uint | ~uint64 | ~uintptr
}

type Number

type Number interface {
	ComparableNumber | float32 | float64
}

type Set

type Set[T comparable] map[T]struct{}

func MakeSet

func MakeSet[T comparable](vs ...T) Set[T]

MakeSet returns a lookup map for T

func ToSet

func ToSet[T comparable](vs []T) Set[T]

ToSet returns a lookup map for T.

func (*Set[T]) Add

func (s *Set[T]) Add(v T)

Add adds v to its elements

func (Set[T]) Contains

func (s Set[T]) Contains(v T) bool

Contains returns true if Set contains v.

func (Set[T]) Equal

func (s Set[T]) Equal(s2 Set[T]) bool

Equal returns true if s and s2 are of equal length and all elements contained in one set are contained in the other.

func (Set[T]) Intersect

func (s Set[T]) Intersect(s2 Set[T]) Set[T]

Intersect returns the intersection of two Sets.

func (Set[T]) Subtract

func (s Set[T]) Subtract(s2 Set[T]) Set[T]

Subtract returns a new Set containing all values from s that are not in s2.

func (Set[T]) Union

func (s Set[T]) Union(s2 Set[T]) Set[T]

Union returns the union of two Sets.