yaml

package
v1.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 9, 2021 License: Apache-2.0 Imports: 11 Imported by: 15

Documentation

Index

Constants

View Source 
const (
	FLAG_TEMPORARY = 0x001
	FLAG_LOCAL     = 0x002
	FLAG_INJECT    = 0x004
	FLAG_STATE     = 0x008
	FLAG_DEFAULT   = 0x010

	FLAG_INJECTED = 0x040
	FLAG_IMPLIED  = 0x080
)
View Source 
const DOCNODE = "__"
View Source 
const MERGEKEY = "<<<"
View Source 
const ROOT = "___"
View Source 
const SELF = "_"

Variables

This section is empty.

Functions

func EmbeddedDynaml added in v1.2.0 

func EmbeddedDynaml(root Node) *string

func Equals added in v1.3.0 

func Equals(a, b Node, path []string) (bool, string)

func FindInt 

func FindInt(root Node, path ...string) (int64, bool)

func FindIntR added in v1.2.0 

func FindIntR(raw bool, root Node, path ...string) (int64, bool)

func FindString 

func FindString(root Node, path ...string) (string, bool)

func FindStringR added in v1.2.0 

func FindStringR(raw bool, root Node, path ...string) (string, bool)

func IsListResolved added in v1.2.0 

func IsListResolved(l []Node) bool

func IsMapResolved added in v1.2.0 

func IsMapResolved(m map[string]Node) bool

func Marshal added in v1.6.0 

func Marshal(node Node) ([]byte, error)

func MassageType added in v1.2.0 

func MassageType(value interface{}) interface{}

func Normalize added in v1.4.0 

func Normalize(root Node) (interface{}, error)

func PathComponent added in v1.2.0 

func PathComponent(step string) string

func ToJSON added in v1.3.0 

func ToJSON(root Node) ([]byte, error)

func ValueToJSON added in v1.3.0 

func ValueToJSON(root interface{}) ([]byte, error)

Types

type AnnotatedNode 

type AnnotatedNode struct {
	Annotation
	// contains filtered or unexported fields
}

func (AnnotatedNode) EquivalentToNode 

func (n AnnotatedNode) EquivalentToNode(o Node) bool

func (AnnotatedNode) GetAnnotation added in v1.2.0 

func (n AnnotatedNode) GetAnnotation() Annotation

func (AnnotatedNode) MarshalYAML 

func (n AnnotatedNode) MarshalYAML() (string, interface{}, error)

func (AnnotatedNode) Resolver added in v1.3.0 

func (n AnnotatedNode) Resolver() RefResolver

func (AnnotatedNode) SourceName 

func (n AnnotatedNode) SourceName() string

func (AnnotatedNode) Value 

func (n AnnotatedNode) Value() interface{}

type Annotation added in v1.2.0 

type Annotation struct {
	NodeFlags
	// contains filtered or unexported fields
}

func EmptyAnnotation added in v1.2.0 

func EmptyAnnotation() Annotation

func NewReferencedAnnotation added in v1.2.0 

func NewReferencedAnnotation(node Node) Annotation

func (Annotation) AddFlags added in v1.2.0 

func (n Annotation) AddFlags(flags NodeFlags) Annotation

func (Annotation) AddIssue added in v1.2.0 

func (n Annotation) AddIssue(error bool, failed bool, issue Issue) Annotation

func (Annotation) AddKeyName added in v1.2.0 

func (n Annotation) AddKeyName(keyName string) Annotation

func (Annotation) Failed added in v1.2.0 

func (n Annotation) Failed() bool

func (Annotation) Flags added in v1.2.0 

func (n Annotation) Flags() NodeFlags

func (Annotation) HasError added in v1.2.0 

func (n Annotation) HasError() bool

func (Annotation) Issue added in v1.2.0 

func (n Annotation) Issue() Issue

func (Annotation) KeyName added in v1.2.0 

func (n Annotation) KeyName() string

func (Annotation) Merged added in v1.2.0 

func (n Annotation) Merged() bool

func (Annotation) Preferred added in v1.2.0 

func (n Annotation) Preferred() bool

func (Annotation) RedirectPath added in v1.2.0 

func (n Annotation) RedirectPath() []string

func (Annotation) ReplaceFlag added in v1.2.0 

func (n Annotation) ReplaceFlag() bool

func (Annotation) SetLocal added in v1.2.0 

func (n Annotation) SetLocal() Annotation

func (Annotation) SetMerged added in v1.2.0 

func (n Annotation) SetMerged() Annotation

func (Annotation) SetPreferred added in v1.2.0 

func (n Annotation) SetPreferred() Annotation

func (Annotation) SetRedirectPath added in v1.2.0 

func (n Annotation) SetRedirectPath(redirect []string) Annotation

func (Annotation) SetReplaceFlag added in v1.2.0 

func (n Annotation) SetReplaceFlag() Annotation

func (Annotation) SetState added in v1.3.0 

func (n Annotation) SetState() Annotation

func (Annotation) SetTemporary added in v1.2.0 

func (n Annotation) SetTemporary() Annotation

func (Annotation) SetUndefined added in v1.2.0 

func (n Annotation) SetUndefined() Annotation

func (Annotation) StandardOverride added in v1.2.0 

func (n Annotation) StandardOverride() bool

func (Annotation) Undefined added in v1.2.0 

func (n Annotation) Undefined() bool

type ComparableValue added in v1.3.0 

type ComparableValue interface {
	EquivalentTo(interface{}) bool
}

type Issue added in v1.2.0 

type Issue struct {
	Issue    string
	Nested   []Issue
	Sequence bool
}

func NewIssue added in v1.2.0 

func NewIssue(msg string, args ...interface{}) Issue

type Node 

type Node interface {
	candiedyaml.Marshaler

	Value() interface{}
	SourceName() string
	RedirectPath() []string
	Flags() NodeFlags
	Temporary() bool
	Local() bool
	State() bool
	ReplaceFlag() bool
	Preferred() bool
	Merged() bool
	StandardOverride() bool
	KeyName() string
	HasError() bool
	Failed() bool
	Undefined() bool
	Issue() Issue

	Resolver() RefResolver

	GetAnnotation() Annotation
	EquivalentToNode(Node) bool
}

func AddFlags added in v1.2.0 

func AddFlags(node Node, flags NodeFlags) Node

func Find 

func Find(root Node, path ...string) (Node, bool)

func FindR added in v1.2.0 

func FindR(raw bool, root Node, path ...string) (Node, bool)

func IssueNode added in v1.2.0 

func IssueNode(node Node, error bool, failed bool, issue Issue) Node

func KeyNameNode added in v1.2.0 

func KeyNameNode(node Node, keyName string) Node

func LocalNode added in v1.2.0 

func LocalNode(node Node) Node

func MergedNode added in v1.2.0 

func MergedNode(node Node) Node

func NewNode 

func NewNode(value interface{}, sourcePath string) Node

func Parse 

func Parse(sourceName string, source []byte) (Node, error)

func ParseMulti added in v1.2.0 

func ParseMulti(sourceName string, source []byte) ([]Node, error)

func PreferredNode added in v1.2.0 

func PreferredNode(node Node) Node

func RedirectNode added in v1.2.0 

func RedirectNode(value interface{}, node Node, redirect []string) Node

func ReferencedNode added in v1.2.0 

func ReferencedNode(node Node) Node

func ReplaceNode added in v1.2.0 

func ReplaceNode(value interface{}, node Node, redirect []string) Node

func ReplaceValue added in v1.2.0 

func ReplaceValue(value interface{}, node Node) Node

func ResolverNode added in v1.3.0 

func ResolverNode(node Node, resolver RefResolver) Node

func Sanitize added in v1.4.0 

func Sanitize(sourceName string, root interface{}) (Node, error)

func StateNode added in v1.3.0 

func StateNode(node Node) Node

func SubstituteNode added in v1.2.0 

func SubstituteNode(value interface{}, node Node) Node

func TemporaryNode added in v1.2.0 

func TemporaryNode(node Node) Node

func UndefinedNode added in v1.2.0 

func UndefinedNode(node Node) Node

func UnescapeDynaml added in v1.5.0 

func UnescapeDynaml(root Node) Node

func Unmarshal added in v1.6.0 

func Unmarshal(sourceName string, source []byte) (Node, error)

func UnmarshalMulti added in v1.6.0 

func UnmarshalMulti(sourceName string, source []byte) ([]Node, error)

func UnresolvedListEntryMerge added in v1.2.0 

func UnresolvedListEntryMerge(node Node) (Node, string, bool)

type NodeFlags added in v1.2.0 

type NodeFlags int

func (*NodeFlags) AddFlags added in v1.2.0 

func (f *NodeFlags) AddFlags(flags NodeFlags) *NodeFlags

func (NodeFlags) Default added in v1.4.0 

func (f NodeFlags) Default() bool

func (NodeFlags) Implied added in v1.4.0 

func (f NodeFlags) Implied() bool

func (NodeFlags) Inject added in v1.3.0 

func (f NodeFlags) Inject() bool

func (NodeFlags) Injected added in v1.3.0 

func (f NodeFlags) Injected() bool

func (NodeFlags) Local added in v1.2.0 

func (f NodeFlags) Local() bool

func (*NodeFlags) Overridden added in v1.4.0 

func (f *NodeFlags) Overridden() NodeFlags

func (NodeFlags) PropagateImplied added in v1.4.0 

func (f NodeFlags) PropagateImplied() bool

func (*NodeFlags) SetDefault added in v1.4.0 

func (f *NodeFlags) SetDefault() *NodeFlags

func (*NodeFlags) SetImplied added in v1.4.0 

func (f *NodeFlags) SetImplied() *NodeFlags

func (*NodeFlags) SetInject added in v1.3.0 

func (f *NodeFlags) SetInject() *NodeFlags

func (*NodeFlags) SetLocal added in v1.2.0 

func (f *NodeFlags) SetLocal() *NodeFlags

func (*NodeFlags) SetState added in v1.3.0 

func (f *NodeFlags) SetState() *NodeFlags

func (*NodeFlags) SetTemporary added in v1.2.0 

func (f *NodeFlags) SetTemporary() *NodeFlags

func (NodeFlags) State added in v1.3.0 

func (f NodeFlags) State() bool

func (NodeFlags) Temporary added in v1.2.0 

func (f NodeFlags) Temporary() bool

type NonStringKeyError 

type NonStringKeyError struct {
	Key interface{}
}

func (NonStringKeyError) Error 

func (e NonStringKeyError) Error() string

type RefResolver added in v1.3.0 

type RefResolver interface {
	FindReference([]string) (Node, bool)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.