extensions

Documentation

Index

• Constants
• func GetExtensionValue[T any](e *Extensions, ext string) (*T, error)
• func UnmarshalExtensionModel[H any, L any](ctx context.Context, e *Extensions, ext string, m *H) ([]error, error)
• type Element
  • func NewElem(key string, value *yaml.Node) *Element
• type Extension
• type Extensions
  • func New(elements ...*Element) *Extensions
  • func (e *Extensions) GetCore() *sequencedmap.Map[string, marshaller.Node[*yaml.Node]]
  • func (e *Extensions) Init()
  • func (e *Extensions) IsEqual(other *Extensions) bool
  • func (e *Extensions) Populate(source any) error
  • func (e *Extensions) SetCore(core any)

Constants

const (
	ErrNotFound = errors.Error("not found")
)

Functions

func GetExtensionValue

func GetExtensionValue[T any](e *Extensions, ext string) (*T, error)

GetExtensionValue will return the value of the extension. Useful for scalar values or where a model without a core is required.

func UnmarshalExtensionModel

func UnmarshalExtensionModel[H any, L any](ctx context.Context, e *Extensions, ext string, m *H) ([]error, error)

UnmarshalExtensionModel will unmarshal the extension into a model and its associated core model.

Types

type Element

type Element struct {
	*sequencedmap.Element[string, Extension]
}

Element represents a key/value pair of a set of extensions.

func NewElem

func NewElem(key string, value *yaml.Node) *Element

NewElem will create a new element for the extensions set.

type Extension

type Extension = *yaml.Node

Extension represents a single extension to an object, in its raw form.

type Extensions

type Extensions struct {
	*sequencedmap.Map[string, Extension]
	// contains filtered or unexported fields
}

Extensions represents a set of extensions to an object.

func New

func New(elements ...*Element) *Extensions

New will create a new extensions set.

func (*Extensions) GetCore

func (e *Extensions) GetCore() *sequencedmap.Map[string, marshaller.Node[*yaml.Node]]

func (*Extensions) Init

func (e *Extensions) Init()

Init will initialize the extensions set.

func (*Extensions) IsEqual

func (e *Extensions) IsEqual(other *Extensions) bool

IsEqual compares two Extensions instances for equality. Treats both empty and nil extensions as equal.

func (*Extensions) Populate

func (e *Extensions) Populate(source any) error

func (*Extensions) SetCore

func (e *Extensions) SetCore(core any)