node

package

v0.0.0-...-b18a026 Latest Latest Go to latest Published: Oct 19, 2020 License: MIT Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

func IsExported(rField *reflect.StructField) bool

IsExported checks whether field is exported..

func IsIgnored(rField *reflect.StructField, tagName string) bool

IsIgnored checks whether field is ignored..

func IsSupportedType(rType reflect.Type) bool

IsSupportedType checks whether type is supported.

type EncoderOption struct {
	TagName        string
	TagDescription string
}

EncoderOption defines option for encoder.

type FlattenMap interface {
	Value(key string) (value string, ok bool)
	ChildrenByPrefix(prefix string) []string
}

FlattenMap provides data to fill a node.

type Node struct {
	Key         string
	Name        string
	Description string
	FiledName   string
	Value       reflect.Value
	Children    []*Node
}

Node defines struct for a field in struct.

func New(element interface{}, option EncoderOption) (*Node, error)

New encodes element into node.

func (node *Node) FillNode(flattenMap FlattenMap) error

FillNode fills data into node.

func (node *Node) Flat() []*Node

Flat gets slice of all nodes sorted by name.

func (node *Node) SerializeValue() string

SerializeValue serializes node's value.

func (node *Node) Walk(callback WalkCallback) error

Walk walks through node and all children.

type WalkCallback func(*Node) error

WalkCallback defines function called when walk.