path

README

path 🏞

Resolve data from arbitrary structures

This is an experimental library for reading/writing values into arbitrary data structures, specifically the map[string]any and []any values returned by Go's json.Unmarshal() functions. It is inspired by the JSON-path standard, but has a very simplified syntax -- using a series of strings separated by dots.

Example Code

s := map[string]any{
    "name":  "John Connor",
    "email": "john@connor.mil",
    "relatives": map[string]any{
        "mom": "Sarah Connor",
        "dad": "Kyle Reese",
    },
    "enemies": []any{"T-1000", "T-3000", "T-5000"},
}

name, err := path.Get(s, "name") // John Connor
email, err := path.Get(s, "email") // john@connor.mil
sarah, err := path.Get(s, "relatives.0") // t-1000

Pull Requests Welcome

Please use GitHub to make suggestions, pull requests, and enhancements. We're all in this together! 🏞

Documentation

Index

• func Delete(object any, name string) error
• func Get(object any, path string) any
• func GetBool(object any, path string) bool
• func GetFloat(object any, path string) float64
• func GetFromMap(object reflect.Value, path string) (any, bool)
• func GetFromSlice(object reflect.Value, path string) (any, bool)
• func GetFromStruct(object reflect.Value, path string) (any, bool)
• func GetInt(object any, path string) int
• func GetInt64(object any, path string) int64
• func GetOK(object any, path string) (any, bool)
• func GetString(object any, path string) string
• func GetWithReflection(object reflect.Value, path string) (any, bool)
• func Index(value string, maximum int) (int, error)
• func Match(object any, criteria exp.Expression) bool
• func Set(object any, name string, value any) error
• func SetAll(object any, dataset map[string]any) error
• func SetBool(object any, path string, value bool) bool
• func SetFloat(object any, path string, value float64) bool
• func SetInt(object any, path string, value int) bool
• func SetInt64(object any, path string, value int64) bool
• func SetString(object any, path string, value string) bool
• func SetToMap(object reflect.Value, path string, value any) error
• func SetToSlice(object reflect.Value, path string, value any) error
• func SetToStruct(object reflect.Value, path string, value any) error
• func SetWithReflection(object reflect.Value, path string, value any) error
• func Split(path string) (string, string)
• type BoolGetter
• type BoolGetterSetter
• type BoolSetter
• type BytesGetter
• type BytesGetterSetter
• type BytesSetter
• type ChildGetter
• type Deleter
• type Delta
  • func NewDelta(object any) Delta
  • func (d *Delta) Error() error
  • func (d *Delta) HasChanged() bool
  • func (d *Delta) SetBool(path string, value bool)
  • func (d *Delta) SetFloat(path string, value float64)
  • func (d *Delta) SetInt(path string, value int)
  • func (d *Delta) SetInt64(path string, value int64)
  • func (d *Delta) SetString(path string, value string)
• type FloatGetter
• type FloatGetterSetter
• type FloatSetter
• type Getter
• type Int64Getter
• type Int64GetterSetter
• type Int64Setter
• type IntGetter
• type IntGetterSetter
• type IntSetter
• type Setter
• type StringGetter
• type StringGetterSetter
• type StringSetter

Functions

func Delete

func Delete(object any, name string) error

Delete tries to remove a value from ths object at this path

func Get

func Get(object any, path string) any

Get tries to return the value of the object at this path.

func GetBool

func GetBool(object any, path string) bool

func GetFloat

func GetFloat(object any, path string) float64

func GetFromMap

func GetFromMap(object reflect.Value, path string) (any, bool)

GetFromMap uses reflection to set a value into a map

func GetFromSlice

func GetFromSlice(object reflect.Value, path string) (any, bool)

func GetFromStruct

func GetFromStruct(object reflect.Value, path string) (any, bool)

GetFromStructreturns a value from a struct. The struct MUST have "path" tags that identify how each field is to be addressed.

func GetInt

func GetInt(object any, path string) int

func GetInt64

func GetInt64(object any, path string) int64

func GetOK

func GetOK(object any, path string) (any, bool)

GetOK returns the value of the object at the provided path. If a value does not already exist, then the OK boolean is false.

func GetString

func GetString(object any, path string) string

func GetWithReflection

func GetWithReflection(object reflect.Value, path string) (any, bool)

func Index

func Index(value string, maximum int) (int, error)

Index is useful for vetting array indices. It attempts to convert the Head() token int an integer, and then check that the integer is within the designated array bounds (is greater than zero, and less than the maximum value provided to the function).

It returns the array index and an error

func Match

func Match(object any, criteria exp.Expression) bool

Match returns TRUE if the provided Getter matches the provided expression

func Set

func Set(object any, name string, value any) error

Set tries to return the value of the object at this path.

func SetAll

func SetAll(object any, dataset map[string]any) error

SetAll adds every path from the dataset into the object. It returns an aggregate error containing all errors generated.

func SetBool

func SetBool(object any, path string, value bool) bool

func SetFloat

func SetFloat(object any, path string, value float64) bool

func SetInt

func SetInt(object any, path string, value int) bool

func SetInt64

func SetInt64(object any, path string, value int64) bool

func SetString

func SetString(object any, path string, value string) bool

func SetToMap

func SetToMap(object reflect.Value, path string, value any) error

SetToMap uses reflection to set a value into a map

func SetToSlice

func SetToSlice(object reflect.Value, path string, value any) error

SetToSlice uses reflection to set a value into a slice/array variable.

func SetToStruct

func SetToStruct(object reflect.Value, path string, value any) error

SetToStruct sets a map reflection value

func SetWithReflection

func SetWithReflection(object reflect.Value, path string, value any) error

SetWithReflection uses a "path" to apply a value to a generic variable.

func Split

func Split(path string) (string, string)

Split splits the path into head and tail strings (separated by ".")

Types

type BoolGetter

type BoolGetter interface {
	GetBool(string) bool
}

type BoolGetterSetter

type BoolGetterSetter interface {
	BoolGetter
	BoolSetter
}

type BoolSetter

type BoolSetter interface {
	SetBool(string, bool) bool
}

type BytesGetter

type BytesGetter interface {
	GetBytes(string) []byte
}

type BytesGetterSetter

type BytesGetterSetter interface {
	BytesGetter
	BytesSetter
}

type BytesSetter

type BytesSetter interface {
	SetBytes(string, []byte) bool
}

type ChildGetter

type ChildGetter interface {
	GetChild(string) (any, bool)
}

type Deleter

type Deleter interface {
	DeletePath(string) error
}

Deleter interface allows other objects to make it easy to trace through their property trees, and delete values from them.

type Delta

type Delta struct {
	// contains filtered or unexported fields
}

Delta tracks changes to an object

func NewDelta

func NewDelta(object any) Delta

NewDelta returns a fully initialized Delta object

func (*Delta) Error

func (d *Delta) Error() error

Error returns derp.MultiError containing all errors that have been collected

func (*Delta) HasChanged

func (d *Delta) HasChanged() bool

HasChanged returns TRUE if any of the values have been changed

func (*Delta) SetBool

func (d *Delta) SetBool(path string, value bool)

SetBool tracks changes to a bool value and collects errors

func (*Delta) SetFloat

func (d *Delta) SetFloat(path string, value float64)

SetFloat tracks changes to a float value and collects errors

func (*Delta) SetInt

func (d *Delta) SetInt(path string, value int)

SetInt tracks changes to an int value and collects errors

func (*Delta) SetInt64

func (d *Delta) SetInt64(path string, value int64)

SetInt64 tracks changes to an int64 value and collects errors

func (*Delta) SetString

func (d *Delta) SetString(path string, value string)

SetString tracks changes to a string value and collects errors

type FloatGetter

type FloatGetter interface {
	GetFloat(string) float64
}

type FloatGetterSetter

type FloatGetterSetter interface {
	FloatGetter
	FloatSetter
}

type FloatSetter

type FloatSetter interface {
	SetFloat(string, float64) bool
}

type Getter

type Getter interface {
	GetPath(string) (any, bool)
}

Getter interface allows other objects to make it easy to trace through their property trees, and get values from them.

type Int64Getter

type Int64Getter interface {
	GetInt64(string) int64
}

type Int64GetterSetter

type Int64GetterSetter interface {
	Int64Getter
	Int64Setter
}

type Int64Setter

type Int64Setter interface {
	SetInt64(string, int64) bool
}

type IntGetter

type IntGetter interface {
	GetInt(string) int
}

type IntGetterSetter

type IntGetterSetter interface {
	IntGetter
	IntSetter
}

type IntSetter

type IntSetter interface {
	SetInt(string, int) bool
}

type Setter

type Setter interface {
	SetPath(string, any) error
}

Setter interface allows other objects to make it easy to trace through their property trees, and set values into them.

type StringGetter

type StringGetter interface {
	GetString(string) string
}

type StringGetterSetter

type StringGetterSetter interface {
	StringGetter
	StringSetter
}

type StringSetter

type StringSetter interface {
	SetString(string, string) bool
}