yaml

package
v2.679.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2026 License: MIT Imports: 4 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func Marshal added in v2.506.0 

func Marshal(v any) ([]byte, error)

Marshal encodes v as YAML.

func Unmarshal added in v2.506.0 

func Unmarshal(data []byte, v any) error

Unmarshal decodes one YAML document from data into v.

It uses Decode, so it rejects additional YAML documents after the first payload.

Types

type Encoder 

type Encoder struct{}

Encoder implements YAML encoding and decoding.

It uses go-yaml v3 with unknown fields and trailing documents rejected.

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). Decode reads one YAML document and rejects unknown fields and additional documents in the same stream.

func (*Encoder) Encode 

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

Encode writes v to w as YAML.

Encode closes the upstream YAML encoder after writing so final buffered data and finalization errors are handled.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.