yaml

Documentation

Overview

Package yaml implements a YAML Marshaler.

Index

• type Yaml
  • func (j *Yaml) ContentTypes() []string
  • func (j *Yaml) Exts() []string
  • func (j *Yaml) Marshal(v any) ([]byte, error)
  • func (j *Yaml) Marshals(v any) bool
  • func (j *Yaml) Name() string
  • func (j *Yaml) NewDecoder(r io.Reader) codecs.Decoder
  • func (j *Yaml) NewEncoder(w io.Writer) codecs.Encoder
  • func (j *Yaml) Unmarshal(data []byte, v any) error
  • func (j *Yaml) Unmarshals(v any) bool

Types

type Yaml

type Yaml struct{}

Yaml implements the codecs.Marshaler interface. It can be used to encode/decode yaml files, or web requests.

func (*Yaml) ContentTypes

func (j *Yaml) ContentTypes() []string

ContentTypes returns the content types the marshaller can handle.

func (*Yaml) Exts

func (j *Yaml) Exts() []string

Exts is a list of file extensions this marshaler supports.

func (*Yaml) Marshal

func (j *Yaml) Marshal(v any) ([]byte, error)

Marshal encodes any pointer into yaml byte.

func (*Yaml) Marshals

func (j *Yaml) Marshals(v any) bool

Marshals returns if this is able to encode the given type.

func (*Yaml) Name

func (j *Yaml) Name() string

Name returns the codec name.

func (*Yaml) NewDecoder

func (j *Yaml) NewDecoder(r io.Reader) codecs.Decoder

NewDecoder returns a new JSON/ProtocolBuffer decoder.

func (*Yaml) NewEncoder

func (j *Yaml) NewEncoder(w io.Writer) codecs.Encoder

NewEncoder returns a new JSON/ProtocolBuffer encoder.

func (*Yaml) Unmarshal

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

Unmarshal decodes yaml bytes into object v. Param v should be a pointer type.

func (*Yaml) Unmarshals

func (j *Yaml) Unmarshals(v any) bool

Unmarshals returns if this is able to decode the given type.