yaml

Documentation

Overview

yaml provides a way to encode both the simple form and the detailed form of configuration data for the goschtalt library.

Index

• Variables
• type Encoder
  • func (e Encoder) Encode(a any) ([]byte, error)
  • func (e Encoder) EncodeExtended(obj meta.Object) ([]byte, error)
  • func (e Encoder) Extensions() []string

Variables

var (
	ErrEncoding = errors.New("encoding error")
)

Types

type Encoder

type Encoder struct{}

Encoder is a class for the yaml encoder.

func (Encoder) Encode

func (e Encoder) Encode(a any) ([]byte, error)

Encode encodes the value provided into yaml and returns the bytes.

func (Encoder) EncodeExtended

func (e Encoder) EncodeExtended(obj meta.Object) ([]byte, error)

Encode encodes the meta.Object provided into yaml with comments showing the origin of the configuration and returns the bytes.

func (Encoder) Extensions

func (e Encoder) Extensions() []string

Extensions returns the supported extensions.