value

Documentation

Overview

Package value provides types that can be used to represent structured data that include comments

Index

• type Interface
  • func New(in interface{}) Interface
• type List
  • func (v *List) Comment() string
  • func (v *List) Get(path ...interface{}) Interface
  • func (v *List) Nodes() []Node
  • func (v *List) SetComment(c string)
  • func (v *List) Value() interface{}
• type Map
  • func (v *Map) Comment() string
  • func (v *Map) Get(path ...interface{}) Interface
  • func (v *Map) Keys() []string
  • func (v *Map) Nodes() []Node
  • func (v *Map) Set(key string, value interface{})
  • func (v *Map) SetComment(c string)
  • func (v *Map) Value() interface{}
• type Node
  • func (n Node) String() string
• type Scalar
  • func (v *Scalar) Comment() string
  • func (v *Scalar) Get(path ...interface{}) Interface
  • func (v *Scalar) Nodes() []Node
  • func (v *Scalar) SetComment(c string)
  • func (v *Scalar) Value() interface{}

Types

type Interface

type Interface interface {
	Get(...interface{}) Interface
	Value() interface{}
	Comment() string
	SetComment(string)
	Nodes() []Node
}

Interface is the main interface for the value package

func New

func New(in interface{}) Interface

New returns a new Interface from the provided value

type List

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

List represents a slice value

func (*List) Comment

func (v *List) Comment() string

Comment returns the List's comment

func (*List) Get

func (v *List) Get(path ...interface{}) Interface

Get returns an element from the List

func (*List) Nodes

func (v *List) Nodes() []Node

Nodes returns the contents of the List as a list of []Node

func (*List) SetComment

func (v *List) SetComment(c string)

SetComment sets the List's comment

func (*List) Value

func (v *List) Value() interface{}

Value returns the value of the List

type Map

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

Map represents a map[string]interface value

func (*Map) Comment

func (v *Map) Comment() string

Comment returns the Map's comment

func (*Map) Get

func (v *Map) Get(path ...interface{}) Interface

Get returns an element from the Map

func (*Map) Keys

func (v *Map) Keys() []string

Keys returns the Map's keys

func (*Map) Nodes

func (v *Map) Nodes() []Node

Nodes returns the contents of the Map as a list of []Node

func (*Map) Set

func (v *Map) Set(key string, value interface{})

Set sets the value of a key within the Map

func (*Map) SetComment

func (v *Map) SetComment(c string)

SetComment sets the Map's comment

func (*Map) Value

func (v *Map) Value() interface{}

Value returns the value of the Map

type Node

type Node struct {
	Path    []interface{}
	Content Interface
}

Node is an element of a structure data value

func (Node) String

func (n Node) String() string

type Scalar

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

Scalar represents an arbitrary (scalar) interface{} value

func (*Scalar) Comment

func (v *Scalar) Comment() string

Comment returns the Scalar's comment

func (*Scalar) Get

func (v *Scalar) Get(path ...interface{}) Interface

Get returns the Scalar's value. Only an empty path is valid.

func (*Scalar) Nodes

func (v *Scalar) Nodes() []Node

Nodes returns the Scalar's value in a list of []Node

func (*Scalar) SetComment

func (v *Scalar) SetComment(c string)

SetComment sets the Scalar's comment

func (*Scalar) Value

func (v *Scalar) Value() interface{}

Value returns the value of the Scalar