utils

README

Stellar Go Utils

Packages

Package	Usage	Docs
encryption	Basic utilities for encrypting and decrypting values with AES-256-GCM encryption
environment	Parse environment variables to a predefined struct. Supports loading from .env files.

Documentation

Index

• Variables
• func ChunkSlice[T any](items []T, size int) [][]T
• func FilterPartialDuplicates(in []string) []string
• func FindProjectRoot(depth int) (root string, err error)
• func HashFromStrings(values ...string) (string, error)
• func IsBool(in any) bool
• func IsFloat32(in any) bool
• func IsFloat64(in any) bool
• func IsInt(in any) bool
• func IsInt16(in any) bool
• func IsInt32(in any) bool
• func IsInt64(in any) bool
• func IsInt8(in any) bool
• func IsMap(in any) bool
• func IsSlice(in any) bool
• func IsString(in any) bool
• func IsStruct(in any) bool
• func IsTime(in any) bool
• func IsUint(in any) bool
• func IsUint16(in any) bool
• func IsUint32(in any) bool
• func IsUint64(in any) bool
• func IsUint8(in any) bool
• func MapHasKey[K comparable, V any](m map[K]V, key K) bool
• func MustHashFromStrings(values ...string) string
• func RandomBytes(n int) ([]byte, error)
• func RandomString(n int) (string, error)
• func RandomStringFromLetterSet(n int, l string) (string, error)
• func RandomStringURLSafe(n int) (string, error)
• func Set[T comparable](a []T) []T
• func ShouldHashFromStrings(values ...string) string
• func SliceContains[T comparable](arr []T, item T) bool

Variables

var ErrNoValues = errors.New("no values provided")

Functions

func ChunkSlice

func ChunkSlice[T any](items []T, size int) [][]T

ChuckSlice creates a slice of slices of a max chunk size. Given a size argument of 4:

[]int{1,2,3,4,5,6,7,9}
// Becomes:
[][]int{ {1,2,3,4}, {5,6,7,8}, {9} }

func FilterPartialDuplicates

func FilterPartialDuplicates(in []string) []string

FilterPartialDuplicates takes a slice of strings and filters out items that are a partial match for other items in the slice. For example:

[]string{"thing1", "thing that has thing1", "thing2", "thing that has thing2", "thing3"}
// Becomes:
[]string{"thing1", "thing2", "thing3"}

func FindProjectRoot

func FindProjectRoot(depth int) (root string, err error)

FindProjectRoot finds the root of a Go project.

func HashFromStrings

func HashFromStrings(values ...string) (string, error)

HashFromStrings creates a SHA256 checksum from any number of input string values.

func IsBool

func IsBool(in any) bool

IsBool determines if a value is a boolean.

func IsFloat32

func IsFloat32(in any) bool

IsFloat32 determines if a value is a 32 bit float.

func IsFloat64

func IsFloat64(in any) bool

IsFloat64 determines if a value is a 64 bit float.

func IsInt

func IsInt(in any) bool

IsInt determines if a value is an integer.

func IsInt16

func IsInt16(in any) bool

IsInt16 determines if a value is a 16 bit integer.

func IsInt32

func IsInt32(in any) bool

IsInt32 determines if a value is a 32 bit integer.

func IsInt64

func IsInt64(in any) bool

IsInt64 determines if a value is a 64 bit integer.

func IsInt8

func IsInt8(in any) bool

IsInt8 determines if a value is an 8 bit integer.

func IsMap

func IsMap(in any) bool

IsMap determines if a value is a map.

func IsSlice

func IsSlice(in any) bool

IsSlice determines if a value is a slice.

func IsString

func IsString(in any) bool

IsString determines if a value is a string.

func IsStruct

func IsStruct(in any) bool

IsStruct determines if a value is a struct.

func IsTime

func IsTime(in any) bool

IsTime determines if a value is a time.Time object.

func IsUint

func IsUint(in any) bool

IsUint determines if a value is an unsigned integer.

func IsUint16

func IsUint16(in any) bool

IsUint16 determines if a value is an unsigned 16 bit integer.

func IsUint32

func IsUint32(in any) bool

IsUint32 determines if a value is an unsigned 32 bit integer.

func IsUint64

func IsUint64(in any) bool

IsUint64 determines if a value is an unsigned 64 bit integer.

func IsUint8

func IsUint8(in any) bool

IsUint8 determines if a value is an 8 bit unsigned integer.

func MapHasKey

func MapHasKey[K comparable, V any](m map[K]V, key K) bool

MapHasKey determines if a given map has an entry for a given key.

func MustHashFromStrings

func MustHashFromStrings(values ...string) string

MustHashFromStrings creates a SHA256 checksum from any number of input string values and panics on error.

func RandomBytes

func RandomBytes(n int) ([]byte, error)

RandomBytes generates cryptographically secure random bytes.

func RandomString

func RandomString(n int) (string, error)

RandomString generates a cryptographically secure random string.

func RandomStringFromLetterSet

func RandomStringFromLetterSet(n int, l string) (string, error)

RandomStringFromLetterSet generates a cryptographically secure random string from a given set of letters. RandomStringFromLetterSet is used as the backend for RandomString and RandomStringURLSafe.

func RandomStringURLSafe

func RandomStringURLSafe(n int) (string, error)

RandomStringURLSafe generates a cryptographically secure random string that is URL safe.

func Set

func Set[T comparable](a []T) []T

Set creates a slice of unique elements from an input slice. Order is not guaranteed.

Example

Set([]string{"one", "two", "two"}) // []string{"one", "two"}

func ShouldHashFromStrings

func ShouldHashFromStrings(values ...string) string

ShouldHashFromStrings creates a SHA256 checksum from any number of input string values. On error, a `__` joined string of input values is returned.

func SliceContains

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

SliceContains determines if a given slice contains a given item.