property

Documentation

Index

• type List
  • func BuildList(rawProperties []interface{}) (List, error)
• type Map
  • func BuildMap(rawProperties map[interface{}]interface{}) (Map, error)
  • func (m *Map) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Property
  • func Build(val interface{}) (Property, error)

Types

type List

type List []Property

func BuildList

func BuildList(rawProperties []interface{}) (List, error)

BuildList creates a new property List from an slice of interface{}, erroring if any elements are maps with non-string keys. Slices in the property List are converted to property Lists. Maps in the property List are converted to property Maps.

type Map

type Map map[string]Property

func BuildMap

func BuildMap(rawProperties map[interface{}]interface{}) (Map, error)

BuildMap creates a new string keyed map from an interface{}-keyed map, erroring if a key is not a string

func (*Map) UnmarshalYAML

func (m *Map) UnmarshalYAML(unmarshal func(interface{}) error) error

type Property

type Property interface{}

Property represents a constrained value which can be a Map, a List, or a primitive. If the property is a Map, keys must be strings and values are properties. These constraints are only enforced by the builder functions: Build, BuildMap, and BuildList.

func Build

func Build(val interface{}) (Property, error)

Build creates a generic property that may be a Map, List or primitive. If it is a Map or List it will be built using the appropriate builder and constraints.