utils

Documentation

Overview

These are a set of very bespoke utilities with specific set of defaults. Not meant to be an exhaustive set of utilities with a wide range of customizations

Index

• func AlphaReverseMap(alphabet string, out map[rune]uint) map[rune]uint
• func EncodeURIComponent(str string) string
• func EnsureDirOf(path string) error
• func EnsureEnvOrDefault(currval string, envvar string, defaultValue string) string
• func ExcelDecode(encoded string, alphabet string, revmap map[rune]uint) uint64
• func ExcelEncode(value uint64, alphabet string) string
• func ExpandUserPath(path string) string
• func GetEnvOrDefault(envvar string, defaultValue string, ensure bool) string
• func GetEnvOrDefaultInt(envvar string, defaultvalue int) (int, error)
• func GetMapField(input StrMap, fieldPath interface{}) (any, error)
• func GetMapFieldForced(input StrMap, fieldPath interface{}) any
• func IsDirEmpty(name string) (bool, error)
• func JsonDecodeBytes(bytes []byte) (interface{}, error)
• func JsonReadFile(path string) (interface{}, error)
• func JsonWriteFile(data interface{}, path string, perm os.FileMode) error
• func PaddedWith(input string, padding byte) string
• func RandString(length int, chars string) string
• type DefaultMap
  • func NewDefaultMap[V any](creator func(key string) V) *DefaultMap[V]
  • func (tm *DefaultMap[V]) Ensure(key string) V
  • func (tm *DefaultMap[V]) Get(key string) (V, bool)
• type StrMap
  • func CopyMapFields(input StrMap, output StrMap, field_paths ...interface{}) (StrMap, error)
  • func SetMapField(input StrMap, fieldPath interface{}, value interface{}) (StrMap, error)
  • func SetMapFields(input StrMap, field_paths_and_values ...interface{}) (StrMap, error)

Functions

func AlphaReverseMap

func AlphaReverseMap(alphabet string, out map[rune]uint) map[rune]uint

func EncodeURIComponent

func EncodeURIComponent(str string) string

func EnsureDirOf

func EnsureDirOf(path string) error

func EnsureEnvOrDefault

func EnsureEnvOrDefault(currval string, envvar string, defaultValue string) string

func ExcelDecode

func ExcelDecode(encoded string, alphabet string, revmap map[rune]uint) uint64

func ExcelEncode

func ExcelEncode(value uint64, alphabet string) string

func ExpandUserPath

func ExpandUserPath(path string) string

func GetEnvOrDefault

func GetEnvOrDefault(envvar string, defaultValue string, ensure bool) string

Gets the value of an environment value and if it is missing returns the default value.

func GetEnvOrDefaultInt

func GetEnvOrDefaultInt(envvar string, defaultvalue int) (int, error)

func GetMapField

func GetMapField(input StrMap, fieldPath interface{}) (any, error)

func GetMapFieldForced

func GetMapFieldForced(input StrMap, fieldPath interface{}) any

func IsDirEmpty

func IsDirEmpty(name string) (bool, error)

func JsonDecodeBytes

func JsonDecodeBytes(bytes []byte) (interface{}, error)

func JsonReadFile

func JsonReadFile(path string) (interface{}, error)

func JsonWriteFile

func JsonWriteFile(data interface{}, path string, perm os.FileMode) error

func PaddedWith

func PaddedWith(input string, padding byte) string

func RandString

func RandString(length int, chars string) string

Types

type DefaultMap

type DefaultMap[V interface{}] struct {
	// contains filtered or unexported fields
}

func NewDefaultMap

func NewDefaultMap[V any](creator func(key string) V) *DefaultMap[V]

func (*DefaultMap[V]) Ensure

func (tm *DefaultMap[V]) Ensure(key string) V

func (*DefaultMap[V]) Get

func (tm *DefaultMap[V]) Get(key string) (V, bool)

type StrMap

type StrMap = map[string]any

func CopyMapFields

func CopyMapFields(input StrMap, output StrMap, field_paths ...interface{}) (StrMap, error)

*

• Copy a value in a given field path from the source into a fieldpath in the dest if
• a. source field path is valid and exists
• b. dest field path is valid (or needs to be created).

func SetMapField

func SetMapField(input StrMap, fieldPath interface{}, value interface{}) (StrMap, error)

*

• Sets a map field at a given field path ensuring that everything until the leaf is a dictionary indeed.

func SetMapFields

func SetMapFields(input StrMap, field_paths_and_values ...interface{}) (StrMap, error)

*

• SetMapFields takes a map and a list of field paths and values and sets the values in the map
• @param input the map to set the values in
• @param field_paths_and_values a list of field paths and values. The field paths are strings separated by "/" and the values are the values to set
• @return error if there is an error at the first fieldpath that failed.