node

package

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

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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.