Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

schema

package

Go to main page

Versions in this module

v0

v0.0.12

Sep 24, 2025

v0.0.11

Apr 29, 2025

v0.0.10

Nov 27, 2024

v0.0.9

Sep 25, 2024

v0.0.8

Sep 23, 2024

v0.0.7

Sep 17, 2024

v0.0.6

Sep 2, 2024

v0.0.5

Feb 13, 2024

v0.0.4

Feb 7, 2024

Changes in this version

+ const Current

+ const Deprecated

+ const Obsolete

+ func AddDefaults(schema Node, under datanode.DataNode) datanode.DataNode

+ func ConvertToXpathNode(c datanode.DataNode, s Node) xutils.XpathNode

+ func FilterTree(schema Node, under datanode.DataNode, keep_it Filter) datanode.DataNode

+ func IsActiveDefault(sch Node, name string, cfgChkr ConfigChecker) bool

+ func NewEmptyLeafValueError(name string, path []string) error

+ func NewInvalidPathError(path []string) error

+ func NewMissingChildError(path []string) error

+ func NewMissingKeyError(path []string) error

+ func NewMissingValueError(path []string) error

+ func NewNode() *node

+ func NewNodeExistsError(path []string) error

+ func NewNodeNotExistsError(path []string) error

+ func NewPathInvalidError(path []string, invalidElem string) error

+ func NewSchemaMismatchError(name string, path []string) error

+ func ValidateSchema(sn Node, c datanode.DataNode, debug bool) ([]*exec.Output, []error, bool)

+ func ValidateSchemaWithLog(sn Node, c datanode.DataNode, options ...YangDebugOption) ([]*exec.Output, []error, bool)

+ type ActionFnType func(targetNode Node, parentNode *XNode, nodeToFind NodeSpec, path []string, ...) (done, success bool, retSlice []interface{})

+ type Binary interface

+ Length func() *Length

+ func NewBinary() Binary

+ type Bit struct

+ Desc string

+ Name string

+ Pos int32

+ Ref string

+ func NewBit(name, desc, ref string, status Status, pos int32) *Bit

+ func (b *Bit) Status() Status

+ func (b *Bit) String() string

+ type BitWidth int

+ const BitWidth16

+ const BitWidth32

+ const BitWidth64

+ const BitWidth8

+ type Bits interface

+ Bits func() []*Bit

+ func NewBits(bs []*Bit) Bits

+ type Boolean interface

+ func NewBoolean(name xml.Name, def string, hasDef bool) Boolean

+ type Case interface

+ func NewCase(name, namespace, modulename, submodule, desc, ref string, config bool, ...) (Case, error)

+ type Choice interface

+ DefaultCase func() string

+ func NewChoice(name, namespace, modulename, submodulename, def, desc, ref string, ...) (Choice, error)

+ type ConfigChecker func(sch Node) bool

+ type Container interface

+ Presence func() bool

+ func NewContainer(name, namespace, modulename, submodule, desc, ref string, ...) (Container, error)

+ type Decimal64 interface

+ Fd func() Fracdigit

+ Rbs func() DrbSlice

+ func NewDecimal64(name xml.Name, fd Fracdigit, rbs []Drb, msg string, appTag string, def string, ...) Decimal64

+ type Drb struct

+ End float64

+ Start float64

+ func NewDecimalRangeBoundary(start, end float64) Drb

+ func (r Drb) Error() string

+ func (r Drb) String() string

+ func (r Drb) Validate(i float64) error

+ type DrbSlice []Drb

+ func (rangeBdry DrbSlice) Append(start, end interface{}) RangeBoundarySlicer

+ func (rangeBdry DrbSlice) Contiguous(lower, higher interface{}) bool

+ func (rangeBdry DrbSlice) Create(entries, capacity int) RangeBoundarySlicer

+ func (rangeBdry DrbSlice) GetEnd(i int) interface{}

+ func (rangeBdry DrbSlice) GetStart(i int) interface{}

+ func (rangeBdry DrbSlice) GreaterThan(first, second interface{}) bool

+ func (rangeBdry DrbSlice) Len() int

+ func (rangeBdry DrbSlice) LessThan(first, second interface{}) bool

+ func (rangeBdry DrbSlice) Parse(start string, base int, bitSize int) (interface{}, error)

+ func (rangeBdry DrbSlice) String(i int) string

+ type Empty interface

+ func NewEmpty(name xml.Name, def string, hasDef bool) Empty

+ type Enum struct

+ Desc string

+ Ref string

+ Val string

+ Value int

+ func NewEnum(val, desc, ref string, status Status, value int) *Enum

+ func (e *Enum) Status() Status

+ func (e *Enum) String() string

+ type Enumeration interface

+ Enums func() []*Enum

+ String func() string

+ func NewEnumeration(name xml.Name, enums []*Enum, def string, hasDef bool) Enumeration

+ type Filter func(Node, datanode.DataNode, []datanode.DataNode) bool

+ type Fracdigit int

+ type Identity struct

+ Desc string

+ Module string

+ Namespace string

+ Ref string

+ Val string

+ Value string

+ func NewIdentity(mod, namespace, val, desc, ref string, status Status, value string) *Identity

+ func (i *Identity) Status() Status

+ func (i *Identity) String() string

+ type Identityref interface

+ Identities func() []*Identity

+ String func() string

+ func NewIdentityref(name xml.Name, ids []*Identity, def string, hasDef bool) Identityref

+ type InstanceId interface

+ Require func() bool

+ func NewInstanceId(name xml.Name, require bool, def string, hasDef bool) InstanceId

+ type Integer interface

+ Rbs func() RbSlice

+ func NewInteger(bitSize BitWidth, name xml.Name, rbs []Rb, msg string, appTag string, ...) Integer

+ type Lb struct

+ End uint64

+ Start uint64

+ func NewLengthBoundary(start, end uint64) Lb

+ func (l *Lb) Error() string

+ func (l *Lb) String() string

+ func (l *Lb) Validate(i uint64) error

+ type LbSlice []Lb

+ func (rangeBdry LbSlice) Append(start, end interface{}) RangeBoundarySlicer

+ func (rangeBdry LbSlice) Contiguous(lower, higher interface{}) bool

+ func (rangeBdry LbSlice) Create(entries, capacity int) RangeBoundarySlicer

+ func (rangeBdry LbSlice) GetEnd(i int) interface{}

+ func (rangeBdry LbSlice) GetStart(i int) interface{}

+ func (rangeBdry LbSlice) GreaterThan(first, second interface{}) bool

+ func (rangeBdry LbSlice) Len() int

+ func (rangeBdry LbSlice) LessThan(first, second interface{}) bool

+ func (rangeBdry LbSlice) Parse(start string, base int, bitSize int) (interface{}, error)

+ func (rangeBdry LbSlice) String(i int) string

+ type Leaf interface

+ Default func() (string, bool)

+ func NewLeaf(name, namespace, modulename, submodule, desc, ref, units string, ...) Leaf

+ type LeafList interface

+ Limit func() Limit

+ func NewLeafList(...) LeafList

+ type LeafValue interface

+ IsLeafValue func()

+ type Leafref interface

+ GetAbsPath func(xutils.PathType) xutils.PathType

+ Mach func() *xpath.Machine

+ func NewLeafref(name xml.Name, mach *xpath.Machine, def string, hasDef bool) Leafref

+ type Length struct

+ AppTag string

+ Lbs LbSlice

+ Msg string

+ func (l *Length) Validate(i uint64) error

+ type Limit struct

+ Max uint

+ Min uint

+ type List interface

+ Keys func() []string

+ Limit func() Limit

+ Uniques func() [][][]xml.Name

+ func NewList(name, namespace, modulename, submodule, desc, ref, orderedby string, ...) (List, error)

+ type ListEntry interface

+ Keys func() []string

+ type Model interface

+ Data func() string

+ Deviations func() []string

+ EncodeXML func(*xml.Encoder)

+ Features func() []string

+ Identifier func() string

+ Notifications func() map[string]Notification

+ Rpcs func() map[string]Rpc

+ Version func() string

+ func NewModel(name, revision, namespace, data string, tree Tree, rpcs map[string]Rpc, ...) Model

+ type ModelSet interface

+ FindOrWalk func(nodeToFind NodeSpec, actionFn ActionFnType, param interface{}) (Node, bool, []interface{})

+ Modules func() map[string]Model

+ Notifications func() map[string]map[string]Notification

+ Rpcs func() map[string]map[string]Rpc

+ Submodules func() map[string]Submodule

+ func NewModelSet(modules map[string]Model, submodules map[string]Submodule) (ModelSet, error)

+ type MustContext struct

+ ExtPathEvalMach *xpath.Machine

+ func NewMustContext(mach, basePathEvalMach, extPathEvalMach *xpath.Machine, errMsg string, ...) MustContext

+ type Node interface

+ Arguments func() []string

+ CheckCardinality func(xutils.PathType, int) error

+ Child func(string) Node

+ Children func() []Node

+ Choices func() []Node

+ Config func() bool

+ DefaultChild func(name string) Node

+ DefaultChildNames func() []string

+ DefaultChildren func() []Node

+ Descendant func([]string) Node

+ Description func() string

+ HasDefault func() bool

+ HasPresence func() bool

+ Mandatory func() bool

+ Module func() string

+ Musts func() []MustContext

+ Name func() string

+ Namespace func() string

+ OpdChildren func() []Node

+ OrdBy func() string

+ Parent func() *node

+ Paths func(string) []string

+ Repeatable func() bool

+ Status func() Status

+ String func() string

+ Submodule func() string

+ Type func() Type

+ Validate func(ValidateCtx, []string, []string) error

+ Whens func() []WhenContext

+ type NodeProperty struct

+ NodeProp string

+ NodeValue string

+ type NodeSpec struct

+ Data NodeSubSpec

+ DataPropNotPresent bool

+ DefaultPropNotPresent bool

+ Path []string

+ Statement NodeSubSpec

+ type NodeSubSpec struct

+ Properties []NodeProperty

+ Type string

+ type Notification interface

+ Schema func() Tree

+ func NewNotification(n Tree) Notification

+ type Number interface

+ AppTag func() string

+ BitWidth func() BitWidth

+ Msg func() string

+ Ranges func() RangeBoundarySlicer

+ type OpdArgument interface

+ Default func() (string, bool)

+ Local func() bool

+ OnEnter func() string

+ PassOpcArgs func() bool

+ Privileged func() bool

+ Secret func() bool

+ func NewOpdArgument(name, namespace, modulename, desc, ref, units, onenter string, priv bool, ...) (OpdArgument, error)

+ type OpdCommand interface

+ Local func() bool

+ OnEnter func() string

+ PassOpcArgs func() bool

+ Privileged func() bool

+ Secret func() bool

+ func NewOpdCommand(name, namespace, modulename, desc, ref, onenter string, priv bool, local bool, ...) (OpdCommand, error)

+ type OpdOption interface

+ Default func() (string, bool)

+ Local func() bool

+ OnEnter func() string

+ PassOpcArgs func() bool

+ Privileged func() bool

+ Secret func() bool

+ func NewOpdOption(name, namespace, modulename, desc, ref, units, onenter string, priv bool, ...) (OpdOption, error)

+ type OpdOptionValue interface

+ IsOpdOptionValue func()

+ type Pattern struct

+ AppTag string

+ Msg string

+ Pattern string

+ func NewPattern(re *regexp.Regexp) Pattern

+ func (p Pattern) String() string

+ func (p Pattern) Validate(s string) error

+ type RangeBoundarySlicer interface

+ Append func(start, end interface{}) RangeBoundarySlicer

+ Contiguous func(lower, higher interface{}) bool

+ Create func(entries, capacity int) RangeBoundarySlicer

+ GetEnd func(i int) interface{}

+ GetStart func(i int) interface{}

+ GreaterThan func(first, second interface{}) bool

+ Len func() int

+ LessThan func(first, second interface{}) bool

+ Parse func(start string, base int, bitSize int) (interface{}, error)

+ String func(i int) string

+ type Rb struct

+ End int64

+ Start int64

+ func NewRangeBoundary(start, end int64) Rb

+ func (r Rb) Error() string

+ func (r Rb) String() string

+ func (r Rb) Validate(i int64) error

+ type RbSlice []Rb

+ func (rangeBdry RbSlice) Append(start, end interface{}) RangeBoundarySlicer

+ func (rangeBdry RbSlice) Contiguous(lower, higher interface{}) bool

+ func (rangeBdry RbSlice) Create(entries, capacity int) RangeBoundarySlicer

+ func (rangeBdry RbSlice) GetEnd(i int) interface{}

+ func (rangeBdry RbSlice) GetStart(i int) interface{}

+ func (rangeBdry RbSlice) GreaterThan(first, second interface{}) bool

+ func (rangeBdry RbSlice) Len() int

+ func (rangeBdry RbSlice) LessThan(first, second interface{}) bool

+ func (rangeBdry RbSlice) Parse(start string, base int, bitSize int) (interface{}, error)

+ func (rangeBdry RbSlice) String(i int) string

+ type Restriction interface

+ type Rpc interface

+ Input func() Tree

+ Output func() Tree

+ func NewRpc(input, output Tree) Rpc

+ type SchemaValidator struct

+ func NewSchemaValidator(sn Node, c datanode.DataNode) *SchemaValidator

+ func (sv *SchemaValidator) SetValidation(valType ValidationType) *SchemaValidator

+ func (sv *SchemaValidator) Validate() ([]*exec.Output, []error, bool)

+ type Status int

+ func (s Status) String() string

+ type String interface

+ Len func() *Length

+ PatHelps func() [][]string

+ Pats func() [][]Pattern

+ func NewString(name xml.Name, pats [][]Pattern, pathelps [][]string, initlen *Length, ...) String

+ type Submodule interface

+ Data func() string

+ EncodeXML func(*xml.Encoder)

+ Identifier func() string

+ Namespace func() string

+ func NewSubmodule(identifier, namespace, revision, data string) Submodule

+ type Tree interface

+ func NewTree(children []Node) (Tree, error)

+ type Type interface

+ AllowedValues func(ctxNode xutils.XpathNode, debug bool) (allowedValues []string, err error)

+ Default func() (string, bool)

+ Name func() xml.Name

+ Validate func(ctx ValidateCtx, path []string, s string) error

+ type Uinteger interface

+ Rbs func() UrbSlice

+ func NewUinteger(bitSize BitWidth, name xml.Name, rbs []Urb, msg string, appTag string, ...) Uinteger

+ type Union interface

+ MatchType func(ctx ValidateCtx, path []string, s string) Type

+ Typs func() []Type

+ func NewUnion(name xml.Name, typs []Type, def string, hasDef bool) Union

+ type Urb struct

+ End uint64

+ Start uint64

+ func NewUnsignedRangeBoundary(start, end uint64) Urb

+ func (r Urb) Error() string

+ func (r Urb) String() string

+ func (r Urb) Validate(i uint64) error

+ type UrbSlice []Urb

+ func (rangeBdry UrbSlice) Append(start, end interface{}) RangeBoundarySlicer

+ func (rangeBdry UrbSlice) Contiguous(lower, higher interface{}) bool

+ func (rangeBdry UrbSlice) Create(entries, capacity int) RangeBoundarySlicer

+ func (rangeBdry UrbSlice) GetEnd(i int) interface{}

+ func (rangeBdry UrbSlice) GetStart(i int) interface{}

+ func (rangeBdry UrbSlice) GreaterThan(first, second interface{}) bool

+ func (rangeBdry UrbSlice) Len() int

+ func (rangeBdry UrbSlice) LessThan(first, second interface{}) bool

+ func (rangeBdry UrbSlice) Parse(start string, base int, bitSize int) (interface{}, error)

+ func (rangeBdry UrbSlice) String(i int) string

+ type ValidateCtx interface

+ AllowIncompletePaths func() bool

+ ErrorHelpText func() []string

+ type ValidationType int

+ const DontValidate

+ const ValidateAll

+ const ValidateConfig

+ const ValidateState

+ type WhenAndMustContext struct

+ AppTag string

+ ErrMsg string

+ Mach *xpath.Machine

+ Namespace string

+ PathEvalMach *xpath.Machine

+ type WhenContext struct

+ RunAsParent bool

+ func NewWhenContext(mach, pathEvalMach *xpath.Machine, errMsg string, runAsParent bool, ...) WhenContext

+ type XNode struct

+ func NewXNode(sn Node, parent *XNode) *XNode

+ func (xn *XNode) XChildren(filter xutils.XFilter, sortSpec xutils.SortSpec) []xutils.XpathNode

+ func (xn *XNode) XIsEphemeral() bool

+ func (xn *XNode) XIsLeaf() bool

+ func (xn *XNode) XIsLeafList() bool

+ func (xn *XNode) XIsNonPresCont() bool

+ func (xn *XNode) XListKeyMatches(key xml.Name, val string) bool

+ func (xn *XNode) XListKeys() []xutils.NodeRefKey

+ func (xn *XNode) XName() string

+ func (xn *XNode) XParent() xutils.XpathNode

+ func (xn *XNode) XPath() xutils.PathType

+ func (xn *XNode) XRoot() xutils.XpathNode

+ func (xn *XNode) XValue() string

+ type YangDebugOption func(*yangValDebugContext)

+ func MustLogThreshold(threshold int) YangDebugOption

+ func ValidationDebug(debug bool) YangDebugOption