godao

README

go-dao

Data Access Object

My personal variable types in Golang. All of which is just an extension and made it simpler to create objects and converting them to other types

warning: this is meant for my own resuble utilities, that i use a lot, and making it available for me to import via go modules

• Map (map[string]any with extra features: access by json path, encode-to-from json/msgpack)
• Array (making array methods similiar to js array)
• Bytes ([]bytes, with value conversion methods)

Documentation

Index

• Constants
• func Allowable(pattern string) (min, max string)
• func GOBDecode(data []byte, src any, useValues ...bool) (err error)
• func GOBEncode(v any, useValues ...bool) (data []byte, err error)
• func IsPattern(str string) bool
• func JsonDecode(data []byte, v any) (err error)
• func JsonEncode(v any, pretty ...bool) (data []byte)
• func MSGPackDecode(data []byte, v any) (err error)
• func MSGPackEncode(v any) (data []byte, err error)
• func MapKeys[K comparable, V any](m map[K]V) (s []K)
• func MapToStruct(src Map, tags string) (newStruct reflect.Type)
• func MapValues[K comparable, V comparable](m map[K]V) (s []V)
• func Match(str, pattern string) bool
• func MatchLimit(str, pattern string, maxcomp int) (matched, stopped bool)
• func MsgDecode(data []byte, v any) (err error)
• func PopulateIntArray(count int) (r []int)
• type Arr
  • func NewArrayType[T comparable](initialValue ...T) (arr *Arr[T])
  • func (a *Arr[T]) Contains(matcher ...T) (r bool)
  • func (a *Arr[T]) Filter(cb func(int, T) bool) (r []T)
  • func (a *Arr[T]) First() T
  • func (a *Arr[T]) ForEach(cb func(int, T, []T))
  • func (a *Arr[T]) Get(index int) (r T)
  • func (a *Arr[T]) GoString() string
  • func (a *Arr[T]) IndexOf(matcher T) (r int)
  • func (a *Arr[T]) Insert(value T, index int) *Arr[T]
  • func (a *Arr[T]) Last() T
  • func (a *Arr[T]) Len() int
  • func (a *Arr[T]) Map(cb func(int, T) T) (r []T)
  • func (a *Arr[T]) MatchPattern(matcher string, result func(int, T)) (r bool)
  • func (a *Arr[T]) Pop() (v T)
  • func (a *Arr[T]) Push(value T) (index int)
  • func (a *Arr[T]) Randomise() *Arr[T]
  • func (a *Arr[T]) Remove(index int, count ...int) []T
  • func (a *Arr[T]) Shift() (v T)
  • func (a *Arr[T]) Sort(order string) *Arr[T]
  • func (a *Arr[T]) String() string
• type Array
  • func NewArray(initialValue ...[]any) *Array
• type Bytes
  • func (b Bytes) Append(data []byte) Bytes
  • func (b Bytes) Clear()
  • func (b Bytes) Contains(f []byte) (ok bool)
  • func (b Bytes) Empty() bool
  • func (b Bytes) Encode(v any) (r Bytes, err error)
  • func (b Bytes) Find(value []byte) (start, end int, extract []byte)
  • func (v Bytes) Float(i ...float64) (val Float)
  • func (b Bytes) GoString() string
  • func (b Bytes) Humanize() string
  • func (v Bytes) Int(i ...int) (val Int)
  • func (b Bytes) IsJSON() bool
  • func (b Bytes) Join(src []Bytes, delim ...rune) (r Bytes)
  • func (b Bytes) ReadFrom(r io.Reader) (int, error)
  • func (b Bytes) Size() int
  • func (b Bytes) Slice(pos int, length ...int) (data []byte)
  • func (b Bytes) Split(delim ...rune) (r []Bytes)
  • func (b Bytes) String() string
  • func (v Bytes) UiInt64(i ...uint64) (val uint64)
  • func (v Bytes) Uint16(i ...uint16) (val uint16)
  • func (v Bytes) Uint32(i ...uint32) (val uint32)
  • func (b Bytes) UnsafeString() string
  • func (b Bytes) Write(value []byte) int
  • func (b Bytes) WriteRune(r []rune) int
  • func (b Bytes) WriteString(s string) int
  • func (b Bytes) WriteTo(w io.Writer) (int, error)
• type Float
  • func (i Float) Bytes() []byte
  • func (i Float) F32() float32
  • func (i Float) FromBytes(v []byte) Float
  • func (i Float) String() string
• type Int
  • func (i Int) Bytes() []byte
  • func (i Int) FromBytes(v []byte) Int
  • func (i Int) I16() int16
  • func (i Int) I32() int32
  • func (i Int) I64() int64
  • func (i Int) I8() int8
  • func (i Int) String() string
• type MStructConfig
• type Map
  • func NewMap() Map
  • func (m Map) Bool(key string) bool
  • func (m Map) ByKeyOrder(sel []string, cb func(int, string, any))
  • func (m Map) Bytes(keys ...string) json.RawValue
  • func (m Map) Call(key string, args ...any) (out any, err error)
  • func (m Map) CanCall(key string) (r bool)
  • func (m Map) Consume(v map[string]any) Map
  • func (m Map) Decode(key string, dst any) (err error)
  • func (m Map) DecodeBinary(data []byte) (mp Map, err error)
  • func (m Map) Del(p string) (res Result)
  • func (m Map) Diffs(src Map) (diff []string)
  • func (m Map) Dom(tag string, inner ...string) (res string)
  • func (m Map) Each(fn func(int, string, any) bool) (a []any)
  • func (m Map) EncodeBinary(additional ...map[string][]rune) (data []byte, err error)
  • func (m Map) EqualKeys(src Map) (r bool)
  • func (m Map) ForEach(cb func(int, string, any))
  • func (m Map) FromBytes(data []byte) (r Result)
  • func (m Map) FromString(data string) (r Result)
  • func (m Map) Get(p string, defaultValue ...any) (res Result)
  • func (m Map) GetAsArray(jpath string) (res []Map)
  • func (m Map) GetByIndex(i int) (k string, v any)
  • func (m Map) HJSON(keys ...string) interface{}
  • func (m Map) Has(keys ...string) bool
  • func (m Map) Int(key string) int
  • func (m Map) Interface(p string) (res any)
  • func (m Map) Iterate(from string, cb func(string, Result) bool) (result Map)
  • func (m Map) JSON(keys ...string) any
  • func (m Map) JSON_Indent(keys ...string) any
  • func (m Map) KeyMatch(pattern string) (key string, value any, ok bool)
  • func (m Map) Keys() []string
  • func (m Map) Length() int
  • func (m Map) Map(key string) Map
  • func (m Map) MatchesKey(pattern string, res func(k string, v any)) (ok bool)
  • func (m Map) Merge(s ...Map) Map
  • func (m Map) MergeStrict(s Map, excludes []string) Map
  • func (m Map) Selective(keys ...string) (o Map)
  • func (m Map) Set(p string, value interface{}) (res any)
  • func (m Map) String(key string) string
  • func (m Map) Values() *Arr[any]
  • func (m Map) ValuesString() []string
• type RawValue
  • func MsgEncode(v any, pretty ...bool) (data RawValue, err error)
• type Result
  • func (r Result) Bytes() []byte
  • func (r Result) Decode(v any) (err error)
  • func (r Result) Delete(path string) (err error)
  • func (r Result) Each(cb func(key, value any) bool)
  • func (r Result) Get(key string) Result
  • func (r Result) Map() Map
  • func (r Result) Set(p string, value any) (err error)
• type SMap
  • func (s *SMap[T, V]) Bytes(pretty ...bool) []byte
  • func (s *SMap[T, V]) Delete(path string)
  • func (s *SMap[T, V]) Get(path string) (val Result)
  • func (s *SMap[T, V]) GetMany(path ...string) (val []Result)
  • func (s *SMap[T, V]) Parse(val []byte) *SMap[T, V]
  • func (s *SMap[T, V]) Set(path string, val V)
  • func (s *SMap[T, V]) String(pretty ...bool) string
• type StringArray

Constants

const (
	FieldNameCamel uint8 = iota
	FieldNameSnake
	FieldNameKebab
)

Functions

func Allowable

func Allowable(pattern string) (min, max string)

Allowable parses the pattern and determines the minimum and maximum allowable values that the pattern can represent. When the max cannot be determined, 'true' will be returned for infinite.

func GOBDecode

func GOBDecode(data []byte, src any, useValues ...bool) (err error)

func GOBEncode

func GOBEncode(v any, useValues ...bool) (data []byte, err error)

func IsPattern

func IsPattern(str string) bool

IsPattern returns true if the string is a pattern.

func JsonDecode

func JsonDecode(data []byte, v any) (err error)

func JsonEncode

func JsonEncode(v any, pretty ...bool) (data []byte)

func MSGPackDecode

func MSGPackDecode(data []byte, v any) (err error)

func MSGPackEncode

func MSGPackEncode(v any) (data []byte, err error)

func MapKeys

func MapKeys[K comparable, V any](m map[K]V) (s []K)

func MapToStruct

func MapToStruct(src Map, tags string) (newStruct reflect.Type)

func MapValues

func MapValues[K comparable, V comparable](m map[K]V) (s []V)

func Match

func Match(str, pattern string) bool

func MatchLimit

func MatchLimit(str, pattern string, maxcomp int) (matched, stopped bool)

func MsgDecode

func MsgDecode(data []byte, v any) (err error)

func PopulateIntArray

func PopulateIntArray(count int) (r []int)

Types

type Arr

type Arr[T string | any] struct {
	Values []T `json:"data,omitempty"`
}

func NewArrayType

func NewArrayType[T comparable](initialValue ...T) (arr *Arr[T])

generic array

func (*Arr[T]) Contains

func (a *Arr[T]) Contains(matcher ...T) (r bool)

func (*Arr[T]) Filter

func (a *Arr[T]) Filter(cb func(int, T) bool) (r []T)

func (*Arr[T]) First

func (a *Arr[T]) First() T

func (*Arr[T]) ForEach

func (a *Arr[T]) ForEach(cb func(int, T, []T))

func (*Arr[T]) Get

func (a *Arr[T]) Get(index int) (r T)

func (*Arr[T]) GoString

func (a *Arr[T]) GoString() string

func (*Arr[T]) IndexOf

func (a *Arr[T]) IndexOf(matcher T) (r int)

func (*Arr[T]) Insert

func (a *Arr[T]) Insert(value T, index int) *Arr[T]

func (*Arr[T]) Last

func (a *Arr[T]) Last() T

func (*Arr[T]) Len

func (a *Arr[T]) Len() int

func (*Arr[T]) Map

func (a *Arr[T]) Map(cb func(int, T) T) (r []T)

func (*Arr[T]) MatchPattern

func (a *Arr[T]) MatchPattern(matcher string, result func(int, T)) (r bool)

func (*Arr[T]) Pop

func (a *Arr[T]) Pop() (v T)

func (*Arr[T]) Push

func (a *Arr[T]) Push(value T) (index int)

func (*Arr[T]) Randomise

func (a *Arr[T]) Randomise() *Arr[T]

func (*Arr[T]) Remove

func (a *Arr[T]) Remove(index int, count ...int) []T

func (*Arr[T]) Shift

func (a *Arr[T]) Shift() (v T)

func (*Arr[T]) Sort

func (a *Arr[T]) Sort(order string) *Arr[T]

func (*Arr[T]) String

func (a *Arr[T]) String() string

type Array

type Array = Arr[any]

Array is a dynamic type of array

func NewArray

func NewArray(initialValue ...[]any) *Array

create a new Array.

type Bytes

type Bytes []byte

func (Bytes) Append

func (b Bytes) Append(data []byte) Bytes

func (Bytes) Clear

func (b Bytes) Clear()

func (Bytes) Contains

func (b Bytes) Contains(f []byte) (ok bool)

func (Bytes) Empty

func (b Bytes) Empty() bool

func (Bytes) Encode

func (b Bytes) Encode(v any) (r Bytes, err error)

func (Bytes) Find

func (b Bytes) Find(value []byte) (start, end int, extract []byte)

func (Bytes) Float

func (v Bytes) Float(i ...float64) (val Float)

func (Bytes) GoString

func (b Bytes) GoString() string

func (Bytes) Humanize

func (b Bytes) Humanize() string

func (Bytes) Int

func (v Bytes) Int(i ...int) (val Int)

func (Bytes) IsJSON

func (b Bytes) IsJSON() bool

func (Bytes) Join

func (b Bytes) Join(src []Bytes, delim ...rune) (r Bytes)

func (Bytes) ReadFrom

func (b Bytes) ReadFrom(r io.Reader) (int, error)

func (Bytes) Size

func (b Bytes) Size() int

func (Bytes) Slice

func (b Bytes) Slice(pos int, length ...int) (data []byte)

func (Bytes) Split

func (b Bytes) Split(delim ...rune) (r []Bytes)

func (Bytes) String

func (b Bytes) String() string

func (Bytes) UiInt64

func (v Bytes) UiInt64(i ...uint64) (val uint64)

func (Bytes) Uint16

func (v Bytes) Uint16(i ...uint16) (val uint16)

func (Bytes) Uint32

func (v Bytes) Uint32(i ...uint32) (val uint32)

func (Bytes) UnsafeString

func (b Bytes) UnsafeString() string

func (Bytes) Write

func (b Bytes) Write(value []byte) int

func (Bytes) WriteRune

func (b Bytes) WriteRune(r []rune) int

func (Bytes) WriteString

func (b Bytes) WriteString(s string) int

func (Bytes) WriteTo

func (b Bytes) WriteTo(w io.Writer) (int, error)

type Float

type Float float64

func (Float) Bytes

func (i Float) Bytes() []byte

func (Float) F32

func (i Float) F32() float32

func (Float) FromBytes

func (i Float) FromBytes(v []byte) Float

func (Float) String

func (i Float) String() string

type Int

type Int int

func (Int) Bytes

func (i Int) Bytes() []byte

func (Int) FromBytes

func (i Int) FromBytes(v []byte) Int

func (Int) I16

func (i Int) I16() int16

func (Int) I32

func (i Int) I32() int32

func (Int) I64

func (i Int) I64() int64

func (Int) I8

func (i Int) I8() int8

func (Int) String

func (i Int) String() string

type MStructConfig

type MStructConfig struct {
	Tag string
}

type Map

type Map map[string]any

func NewMap

func NewMap() Map

func (Map) Bool

func (m Map) Bool(key string) bool

func (Map) ByKeyOrder

func (m Map) ByKeyOrder(sel []string, cb func(int, string, any))

func (Map) Bytes

func (m Map) Bytes(keys ...string) json.RawValue

func (Map) Call

func (m Map) Call(key string, args ...any) (out any, err error)

special func

func (Map) CanCall

func (m Map) CanCall(key string) (r bool)

func (Map) Consume

func (m Map) Consume(v map[string]any) Map

func (Map) Decode

func (m Map) Decode(key string, dst any) (err error)

decode the values into any variable

func (Map) DecodeBinary

func (m Map) DecodeBinary(data []byte) (mp Map, err error)

func (Map) Del

func (m Map) Del(p string) (res Result)

func (Map) Diffs

func (m Map) Diffs(src Map) (diff []string)

func (Map) Dom

func (m Map) Dom(tag string, inner ...string) (res string)

func (Map) Each

func (m Map) Each(fn func(int, string, any) bool) (a []any)

func (Map) EncodeBinary

func (m Map) EncodeBinary(additional ...map[string][]rune) (data []byte, err error)

func (Map) EqualKeys

func (m Map) EqualKeys(src Map) (r bool)

func (Map) ForEach

func (m Map) ForEach(cb func(int, string, any))

func (Map) FromBytes

func (m Map) FromBytes(data []byte) (r Result)

func (Map) FromString

func (m Map) FromString(data string) (r Result)

func (Map) Get

func (m Map) Get(p string, defaultValue ...any) (res Result)

func (Map) GetAsArray

func (m Map) GetAsArray(jpath string) (res []Map)

func (Map) GetByIndex

func (m Map) GetByIndex(i int) (k string, v any)

func (Map) HJSON

func (m Map) HJSON(keys ...string) interface{}

func (Map) Has

func (m Map) Has(keys ...string) bool

func (Map) Int

func (m Map) Int(key string) int

func (Map) Interface

func (m Map) Interface(p string) (res any)

func (Map) Iterate

func (m Map) Iterate(from string, cb func(string, Result) bool) (result Map)

func (Map) JSON

func (m Map) JSON(keys ...string) any

func (Map) JSON_Indent

func (m Map) JSON_Indent(keys ...string) any

func (Map) KeyMatch

func (m Map) KeyMatch(pattern string) (key string, value any, ok bool)

func (Map) Keys

func (m Map) Keys() []string

func (Map) Length

func (m Map) Length() int

func (Map) Map

func (m Map) Map(key string) Map

func (Map) MatchesKey

func (m Map) MatchesKey(pattern string, res func(k string, v any)) (ok bool)

func (Map) Merge

func (m Map) Merge(s ...Map) Map

func (Map) MergeStrict

func (m Map) MergeStrict(s Map, excludes []string) Map

func (Map) Selective

func (m Map) Selective(keys ...string) (o Map)

func (Map) Set

func (m Map) Set(p string, value interface{}) (res any)

func (Map) String

func (m Map) String(key string) string

func (Map) Values

func (m Map) Values() *Arr[any]

func (Map) ValuesString

func (m Map) ValuesString() []string

type RawValue

type RawValue = json.RawValue

func MsgEncode

func MsgEncode(v any, pretty ...bool) (data RawValue, err error)

type Result

type Result struct {
	gjson.Result
}

func (Result) Bytes

func (r Result) Bytes() []byte

func (Result) Decode

func (r Result) Decode(v any) (err error)

func (Result) Delete

func (r Result) Delete(path string) (err error)

func (Result) Each

func (r Result) Each(cb func(key, value any) bool)

func (Result) Get

func (r Result) Get(key string) Result

func (Result) Map

func (r Result) Map() Map

func (Result) Set

func (r Result) Set(p string, value any) (err error)

type SMap

type SMap[T string, V any] struct {
	V map[T]V
}

func (*SMap[T, V]) Bytes

func (s *SMap[T, V]) Bytes(pretty ...bool) []byte

func (*SMap[T, V]) Delete

func (s *SMap[T, V]) Delete(path string)

func (*SMap[T, V]) Get

func (s *SMap[T, V]) Get(path string) (val Result)

func (*SMap[T, V]) GetMany

func (s *SMap[T, V]) GetMany(path ...string) (val []Result)

func (*SMap[T, V]) Parse

func (s *SMap[T, V]) Parse(val []byte) *SMap[T, V]

func (*SMap[T, V]) Set

func (s *SMap[T, V]) Set(path string, val V)

func (*SMap[T, V]) String

func (s *SMap[T, V]) String(pretty ...bool) string

type StringArray

type StringArray = Arr[string]

example of speficic type of array