yaml

Documentation

Overview

Package yaml provides YAML encoding helpers and adapters used by go-service.

This package integrates YAML encoding/decoding behind the go-service encoding abstraction.

Start with the package-level constructors.

Index

• type Encoder
  • func NewEncoder() *Encoder
  • func (e *Encoder) Decode(r io.Reader, v any) error
  • func (e *Encoder) Encode(w io.Writer, v any) error

Types

type Encoder

type Encoder struct{}

Encoder implements YAML encoding and decoding.

It uses go-yaml v3 with default settings.

func NewEncoder

func NewEncoder() *Encoder

NewEncoder constructs a YAML encoder.

This encoder is a thin adapter around go-yaml v3 (imported as go.yaml.in/yaml/v3) that satisfies `github.com/alexfalkowski/go-service/v2/encoding.Encoder`.

func (*Encoder) Decode

func (e *Encoder) Decode(r io.Reader, v any) error

Decode reads YAML from r and decodes it into v.

In most cases v should be a pointer to the destination value (for example *MyStruct). This is a thin wrapper around `yaml.NewDecoder(r).Decode(v)`.

func (*Encoder) Encode

func (e *Encoder) Encode(w io.Writer, v any) error

Encode writes v to w as YAML.

This is a thin wrapper around `yaml.NewEncoder(w).Encode(v)`.