README
¶
Agnostic Raw Data (ARD)
What is "agnostic raw data"?
Agnostic?
Comprising primitives (string, integer, float, boolean, null) and structures (map, list). It's agnostic because it can be trivially represented in practically any language or platform, and also because it can be transmitted in a wide variety of formats.
Note that some formats present limitations:
YAML
YAML supports a rich set of primitive types, so ARD will survive a round trip to YAML.
One difference is that YAML maps can be ordered (!!omap vs. !!map) but ARD maps have arbitrary order (always !!map) for widest compatibility. A round trip from YAML to ARD would thus lose order.
YAML allows for maps with arbitrary keys. This is non-trivial to support in Go, and so we provide
special functions (MapGet, MapPut, MapDelete, MapMerge) that replace the Go native
functionality with additional support for detecting and handling complex keys. This feature is
provided as an independent library, yamlkeys.
JSON
JSON can be read into ARD.
However, because JSON has fewer types and more limitations than YAML (no integers, only floats; map keys can only be string), ARD will lose some type information when translated into JSON.
This could be fixed if we extend JSON with some conventions for encoding extra types. See MongoDB Extended JSON for an example. Also, maps with complex keys could be encoded as key-value pair lists.
XML
XML does not have a type system. Arbitrary XML cannot be parsed into ARD.
However, with a proper schema and custom reader this could be implemented in the future.
Raw?
The data is untreated and not validated. There's no schema.
Documentation
¶
Index ¶
- Constants
- Variables
- func FindYAMLNode(node *yaml.Node, path ...PathElement) *yaml.Node
- func IsBool(value Value) bool
- func IsFloat(value Value) bool
- func IsInteger(value Value) bool
- func IsList(value Value) bool
- func IsMap(value Value) bool
- func IsNull(value Value) bool
- func IsString(value Value) bool
- func IsTime(value Value) bool
- func MergeMaps(target Map, source Map, mergeLists bool)
- func Read(reader io.Reader, format string, locate bool) (Map, Locator, error)
- func ReadFromURL(url urlpkg.URL, locate bool) (Map, Locator, error)
- func ReadJSON(reader io.Reader, locate bool) (Map, Locator, error)
- func ReadYAML(reader io.Reader, locate bool) (Map, Locator, error)
- func StringMapPutNested(map_ StringMap, key string, value string) error
- func ToYAMLDocumentNode(value Value, verbose bool) *yaml.Node
- func ToYAMLNode(value Value, verbose bool) *yaml.Node
- func TypeName(value Value) string
- type List
- type Locator
- type Map
- type Node
- func (self *Node) Append(value interface{}) bool
- func (self *Node) Boolean(allowNil bool) (bool, bool)
- func (self *Node) Float(allowNil bool) (float64, bool)
- func (self *Node) Get(key string) *Node
- func (self *Node) Integer(allowNil bool) (int64, bool)
- func (self *Node) List(allowNil bool) (List, bool)
- func (self *Node) Map(allowNil bool) (Map, bool)
- func (self *Node) Put(key string, value interface{}) bool
- func (self *Node) String(allowNil bool) (string, bool)
- func (self *Node) StringMap(allowNil bool) (StringMap, bool)
- func (self *Node) UnsignedInteger(allowNil bool) (uint64, bool)
- type Path
- type PathElement
- type PathElementType
- type StringMap
- type TypeValidator
- type Value
- type YAMLLocator
Constants ¶
const ( FieldPathType = iota MapPathType ListPathType SequencedListPathType )
Variables ¶
var NoNode = &Node{nil, nil, ""}
Functions ¶
func FindYAMLNode ¶
func FindYAMLNode(node *yaml.Node, path ...PathElement) *yaml.Node
func IsInteger ¶ added in v0.12.0
int64, int32, int16, int8, int, uint64, uint32, uint16, uint8, uint
func StringMapPutNested ¶
TODO: use Node instead
func ToYAMLDocumentNode ¶ added in v0.12.0
func ToYAMLNode ¶ added in v0.12.0
Types ¶
type List ¶
type List = []Value
Note: This is just a convenient alias, *not* a type. An extra type would ensure more strictness but would make life more complicated than it needs to be. That said, if we *do* want to make this into a type, we need to make sure not to add any methods to the type, otherwise the goja JavaScript engine will treat it as a host object instead of a regular JavaScript dict object.
type Map ¶
Note: This is just a convenient alias, *not* a type. An extra type would ensure more strictness but would make life more complicated than it needs to be. That said, if we *do* want to make this into a type, we need to make sure not to add any methods to the type, otherwise the goja JavaScript engine will treat it as a host object instead of a regular JavaScript dict object.
func EnsureMaps ¶
type Node ¶ added in v0.14.0
type Node struct {
Data interface{}
// contains filtered or unexported fields
}
type Path ¶
type Path []PathElement
func (Path) Append ¶ added in v0.13.0
func (self Path) Append(element PathElement) Path
func (Path) AppendField ¶ added in v0.13.0
func (Path) AppendList ¶ added in v0.13.0
func (Path) AppendSequencedList ¶ added in v0.14.0
type PathElement ¶
type PathElement struct {
Type PathElementType
Value interface{} // string for FieldPathType and MapPathType, int for ListPathType and SequencedListPathType
}
func NewFieldPathElement ¶
func NewFieldPathElement(name string) PathElement
func NewListPathElement ¶
func NewListPathElement(index int) PathElement
func NewMapPathElement ¶
func NewMapPathElement(name string) PathElement
func NewSequencedListPathElement ¶ added in v0.14.0
func NewSequencedListPathElement(index int) PathElement
type PathElementType ¶ added in v0.14.0
type PathElementType uint8
type TypeValidator ¶ added in v0.12.0
type YAMLLocator ¶
type YAMLLocator struct {
RootNode *yaml.Node
}
func NewYAMLLocator ¶
func NewYAMLLocator(rootNode *yaml.Node) *YAMLLocator
func (*YAMLLocator) Locate ¶
func (self *YAMLLocator) Locate(path ...PathElement) (int, int, bool)
Locator interface
Source Files