values

func Bool ¶

func Bool(v any) bool

Bool returns bool value

func BoolToBytes ¶ added in v0.16.88

func BoolToBytes(v bool) []byte

BoolToBytes returns []byte{1} or []byte{0}. It is used for deterministic hashing of booleans.

func CanonicalizeJSON ¶ added in v0.15.83

func CanonicalizeJSON(input []byte) ([]byte, error)

CanonicalizeJSON returns the canonical JSON representation of the input, with all object keys sorted alphabetically.

func Coalesce ¶

func Coalesce[M Measurable[any]](args ...M) M

Coalesce returns the first non-empty value

func Float32 ¶ added in v0.8.45

func Float32(v any) float32

Float32 will return the value as float32

func Float64 ¶ added in v0.8.45

func Float64(v any) float64

Float64 will return the value as float64

func IndentJSON ¶ added in v0.12.54

func IndentJSON(data string) string

IndentJSON indents a JSON string It will return the original string if it fails to indent This is useful for pretty printing JSON strings

func Int ¶

func Int(v any) int

Int will return the value as int

func Int64 ¶

func Int64(v any) int64

Int64 will return the value as int64

func IntSlice ¶ added in v0.15.77

func IntSlice(v any) []int

IntSlice returns slice of int values

func IntToBytes ¶ added in v0.16.88

func IntToBytes(v int) []byte

func IsCollection ¶

func IsCollection(value any) bool

IsCollection returns true for slices and maps

func IsEmpty ¶ added in v0.15.81

func IsEmpty(value any) bool

IsEmpty checks if a value is considered empty

func IsMap ¶ added in v0.9.47

func IsMap(value any) bool

func IsSlice ¶ added in v0.9.47

func IsSlice(value any) bool

func JSON ¶ added in v0.4.1

func JSON(value any) string

JSON returns the value as a JSON string

func JSONIndent ¶ added in v0.12.54

func JSONIndent(value any) string

JSONIndent returns the value as a JSON string with indentation

func MarshalCanonicalJSON ¶ added in v0.15.84

func MarshalCanonicalJSON(v any) ([]byte, error)

MarshalCanonicalJSON returns the canonical JSON representation of the value, with all object keys sorted alphabetically.

func NumbersCoalesce ¶

func NumbersCoalesce[T ~int | ~int32 | ~uint | ~uint32 | ~int64 | ~uint64](items ...T) T

NumbersCoalesce returns the first value from the supplied list that is not 0, or 0 if there are no values that are not zero

func Select ¶

func Select[T any](cond bool, a, b T) T

Select returns a if cond is true, otherwise b

func Shrink ¶ added in v0.15.81

func Shrink(value any) any

Shrink removes empty values recursively: - returns nil if value is empty - if it's a Map, then only non empty values are returned in a map, or nil - if it's a Slice, then only non empty values are returned.

// Example with nested structures
input := map[string]any{
	"users": []any{
		map[string]any{"name": "", "age": 0, "active": false},
		map[string]any{"name": "John", "age": 30, "active": true, "tags": []any{"", "admin"}},
		map[string]any{"name": "Jane", "age": 25, "tags": []any{"", "", ""}},
	},
	"config": map[string]any{
		"debug":   false,
		"timeout": 0,
		"host":    "localhost",
	},
	"empty_section": map[string]any{
		"a": "",
		"b": 0,
		"c": []any{},
	},
}

result := Shrink(input)
fmt.Printf("Result: %+v\n", result)

// Example with simple values
fmt.Printf("Empty string: %v\n", Shrink(""))
fmt.Printf("Non-empty string: %v\n", Shrink("hello"))
fmt.Printf("Zero int: %v\n", Shrink(0))
fmt.Printf("Non-zero int: %v\n", Shrink(42))
fmt.Printf("Empty slice: %v\n", Shrink([]any{}))
fmt.Printf("Slice with empty values: %v\n", Shrink([]any{"", 0, false}))
fmt.Printf("Slice with mixed values: %v\n", Shrink([]any{"", "hello", 0, 42}))

Output:
Result: map[config:map[host:localhost] users:[map[active:true age:30 name:John tags:[admin]] map[age:25 name:Jane]]]
Empty string: <nil>
Non-empty string: hello
Zero int: <nil>
Non-zero int: 42
Empty slice: <nil>
Slice with empty values: <nil>
Slice with mixed values: [hello 42]

func String ¶

func String(v any) string

String returns string value

func StringSlice ¶

func StringSlice(v any) []string

StringSlice returns slice of string values

func StringsCoalesce ¶

func StringsCoalesce(str ...string) string

StringsCoalesce returns the first non-empty string value

func Time ¶

func Time(v any) *time.Time

Time will return the value as Time

func UInt64 ¶

func UInt64(v any) uint64

UInt64 will return the value as uint64

func Uint32ToBytes ¶ added in v0.16.88

func Uint32ToBytes(v uint32) []byte

Uint32ToBytes returns v in big-endian order (4 bytes). It is used for deterministic hashing of integers.

func Uint64ToBytes ¶ added in v0.16.88

func Uint64ToBytes(v uint64) []byte

Uint64ToBytes returns v in big-endian order (8 bytes). It is used for deterministic hashing of integers.

func WriteCanonicalJSON ¶ added in v0.15.84

func WriteCanonicalJSON(buf *bytes.Buffer, v any) error

WriteCanonicalJSON writes the canonical JSON representation of the input to the buffer. All keys are sorted alphabetically, at any nesting level.

Values that are not handled natively, such as structs, typed maps and slices, json.RawMessage or custom json.Marshaler implementations, are encoded with encoding/json and then re-encoded from the resulting JSON, as encoding/json preserves the declaration order of struct fields and the original order of raw JSON.

func XXH3Hash64 ¶ added in v0.16.88

func XXH3Hash64(data []byte) uint64

XXH3Hash64 returns the 64-bit XXH3 digest of data. It is fast and non-cryptographic.

func XXH3Hash128 ¶ added in v0.16.88

func XXH3Hash128(data []byte) []byte

XXH3Hash128 returns the 128-bit XXH3 digest of data as 16 bytes in canonical big-endian form (see xxh3.Uint128.Bytes). It is fast and non-cryptographic.

func XXH3Hash128Hex ¶ added in v0.16.88

func XXH3Hash128Hex(data []byte) string

XXH3Hash128Hex returns the lowercase hexadecimal encoding of Hash128(data) (32 characters).

func XXH3HashArgs64 ¶ added in v0.16.90

func XXH3HashArgs64(data ...any) uint64

XXH3HashArgs64 returns a 64-bit XXH3 digest over variadic arguments.

Supported types: string, []string, numeric scalars and slices (uint64, int64, uint32, int32, int), bool and []bool, []byte, enum.ProtoEnum and []enum.ProtoEnum. Other values are serialized with String(v) (see package values). String and []string elements are followed by a zero byte delimiter so adjacent fields do not merge ambiguously. Slices of fixed-width types are written without per-element delimiters; argument order and Go types distinguish fields.

func XXH3HashArgs128 ¶ added in v0.16.90

func XXH3HashArgs128(data ...any) []byte

XXH3HashArgs128 returns a 128-bit XXH3 digest over variadic arguments.

Supported types: string, []string, numeric scalars and slices (uint64, int64, uint32, int32, int), bool and []bool, []byte, enum.ProtoEnum and []enum.ProtoEnum. Other values are serialized with String(v) (see package values). String and []string elements are followed by a zero byte delimiter so adjacent fields do not merge ambiguously. Slices of fixed-width types are written without per-element delimiters; argument order and Go types distinguish fields.

func XXH3HashArgs128Hex ¶ added in v0.16.88

func XXH3HashArgs128Hex(data ...any) string

XXH3HashArgs128Hex returns a 128-bit XXH3 digest over variadic arguments, encoded as lowercase hex (32 characters).

Supported types: string, []string, numeric scalars and slices (uint64, int64, uint32, int32, int), bool and []bool, []byte, enum.ProtoEnum and []enum.ProtoEnum. Other values are serialized with String(v) (see package values). String and []string elements are followed by a zero byte delimiter so adjacent fields do not merge ambiguously. Slices of fixed-width types are written without per-element delimiters; argument order and Go types distinguish fields.

func XXH3HashString64 ¶ added in v0.16.88

func XXH3HashString64(data string) uint64

XXH3HashString64 returns the 64-bit XXH3 digest of the string's UTF-8 bytes. It is fast and non-cryptographic.