README
¶
path 🏞
Resolve data from arbitrary structures
This is an experimental library for reading/writing values into arbitrary data structures, specifically the map[string]interface{} and []interface{} 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]interface{}{
"name": "John Connor",
"email": "john@connor.mil",
"relatives": map[string]interface{}{
"mom": "Sarah Connor",
"dad": "Kyle Reese",
},
"enemies": []interface{}{"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 interface{}, name string) error
- func Get(object interface{}, path string) interface{}
- func GetOK(object interface{}, path string) (interface{}, bool)
- func Index(value string, maximum int) (int, error)
- func Match(getter Getter, criteria exp.Expression) bool
- func Set(object interface{}, name string, value interface{}) error
- func SetAll(object interface{}, dataset map[string]interface{}) error
- type Deleter
- type Getter
- type Setter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Get ¶
func Get(object interface{}, path string) interface{}
Get tries to return the value of the object at this path.
func GetOK ¶ added in v0.8.0
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 Index ¶ added in v0.7.0
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 ¶ added in v0.5.0
func Match(getter Getter, criteria exp.Expression) bool
Match returns TRUE if the provided Getter matches the provided expression
Types ¶
type Deleter ¶ added in v0.3.0
Deleter interface allows other objects to make it easy to trace through their property trees, and delete values from them.
Source Files