validation

Documentation

Index

• func GetContextObject[T any](o *Options) *T
• func NewMapKeyError(err error, core CoreModeler, node mapKeyNodeGetter, key string) error
• func NewMapValueError(err error, core CoreModeler, node mapValueNodeGetter, key string) error
• func NewNodeError(err error, node *yaml.Node) error
• func NewSliceError(err error, core CoreModeler, node sliceNodeGetter, index int) error
• func NewValueError(err error, core CoreModeler, node valueNodeGetter) error
• type CoreModeler
• type Error
  • func (e Error) Error() string
  • func (e Error) Unwrap() error
• type MissingFieldError
  • func NewMissingFieldError(msg string, args ...any) *MissingFieldError
  • func (e MissingFieldError) Error() string
• type MissingValueError
  • func NewMissingValueError(msg string, args ...any) *MissingValueError
  • func (e MissingValueError) Error() string
• type Option
  • func WithContextObject[T any](obj *T) Option
• type Options
  • func NewOptions(opts ...Option) *Options
• type TypeMismatchError
  • func NewTypeMismatchError(msg string, args ...any) *TypeMismatchError
  • func (e TypeMismatchError) Error() string
• type ValueValidationError
  • func NewValueValidationError(msg string, args ...any) *ValueValidationError
  • func (e ValueValidationError) Error() string

Functions

func GetContextObject

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

func NewMapKeyError

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

func NewMapValueError

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

func NewNodeError

func NewNodeError(err error, node *yaml.Node) error

func NewSliceError

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

func NewValueError

func NewValueError(err error, core CoreModeler, node valueNodeGetter) error

Types

type CoreModeler

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

type Error

type Error struct {
	UnderlyingError error
	Line            int
	Column          int
}

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

func (Error) Unwrap

func (e Error) Unwrap() error

type MissingFieldError

type MissingFieldError struct {
	Msg string
}

func NewMissingFieldError

func NewMissingFieldError(msg string, args ...any) *MissingFieldError

func (MissingFieldError) Error

func (e MissingFieldError) Error() string

type MissingValueError

type MissingValueError struct {
	Msg string
}

func NewMissingValueError

func NewMissingValueError(msg string, args ...any) *MissingValueError

func (MissingValueError) Error

func (e MissingValueError) 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

type TypeMismatchError

type TypeMismatchError struct {
	Msg string
}

func NewTypeMismatchError

func NewTypeMismatchError(msg string, args ...any) *TypeMismatchError

func (TypeMismatchError) Error

func (e TypeMismatchError) Error() string

type ValueValidationError

type ValueValidationError struct {
	Msg string
}

func NewValueValidationError

func NewValueValidationError(msg string, args ...any) *ValueValidationError

func (ValueValidationError) Error

func (e ValueValidationError) Error() string