validation

Documentation

Index

• func GetContextObject[T any](o *Options) *T
• func NewMapKeyError(msg string, core CoreModeler, node mapKeyNodeGetter, key string) error
• func NewMapValueError(msg string, core CoreModeler, node mapValueNodeGetter, key string) error
• func NewNodeError(msg string, node *yaml.Node) error
• func NewSliceError(msg string, core CoreModeler, node sliceNodeGetter, index int) error
• func NewValueError(msg string, core CoreModeler, node valueNodeGetter) error
• type CoreModeler
• type Error
  • func (e Error) Error() string
• type Option
  • func WithContextObject[T any](obj *T) Option
• type Options
  • func NewOptions(opts ...Option) *Options

Functions

func GetContextObject

func GetContextObject[T any](o *Options) *T

func NewMapKeyError

func NewMapKeyError(msg string, core CoreModeler, node mapKeyNodeGetter, key string) error

func NewMapValueError

func NewMapValueError(msg string, core CoreModeler, node mapValueNodeGetter, key string) error

func NewNodeError

func NewNodeError(msg string, node *yaml.Node) error

func NewSliceError

func NewSliceError(msg string, core CoreModeler, node sliceNodeGetter, index int) error

func NewValueError

func NewValueError(msg string, core CoreModeler, node valueNodeGetter) error

Types

type CoreModeler

type CoreModeler interface {
	GetRootNode() *yaml.Node
}

type Error

type Error struct {
	Line    int
	Column  int
	Message string
}

Error represents a validation error and the line and column where it occurred TODO allow getting the JSON path for line/column for validation errors

func (Error) Error

func (e Error) Error() string

type Option

type Option func(o *Options)

func WithContextObject

func WithContextObject[T any](obj *T) Option

type Options

type Options struct {
	ContextObjects map[reflect.Type]any
}

func NewOptions

func NewOptions(opts ...Option) *Options