yaml_encoder

README

yaml-encoder

https://github.com/zwgblue/yaml-encoder

This is a yaml encoder which implements yaml.Marshaler for marshal with comments.

Inspired by The doc's encoder of talos

Documentation

Index

• Constants
• type CommentsFlag
• type Encoder
  • func NewEncoder(value interface{}, opts ...Option) *Encoder
  • func (e *Encoder) Encode() ([]byte, error)
  • func (e *Encoder) EncodeDoc() ([]byte, error)
  • func (e *Encoder) Marshal() (*yaml.Node, error)
• type Option
  • func WithComments(flag CommentsFlag) Option
  • func WithCommentsMap(m map[string]string) Option
  • func WithOmitEmpty(value bool) Option
• type Options

Constants

const (
	AttrCommentSep = ". "
)

Types

type CommentsFlag

type CommentsFlag int

CommentsFlag comments encoding flags type.

const (
	CommentsDisabled CommentsFlag = iota
	CommentsOnHead
	CommentsInLine
	CommentsOnFoot
)

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

Encoder implements config encoder.

func NewEncoder

func NewEncoder(value interface{}, opts ...Option) *Encoder

NewEncoder initializes and returns an `Encoder`.

func (*Encoder) Encode

func (e *Encoder) Encode() ([]byte, error)

Encode converts value to yaml.

func (*Encoder) EncodeDoc

func (e *Encoder) EncodeDoc() ([]byte, error)

EncodeDoc converts comment to json.

func (*Encoder) Marshal

func (e *Encoder) Marshal() (*yaml.Node, error)

Marshal converts value to YAML-serializable value (suitable for MarshalYAML).

type Option

type Option func(*Options)

Option gives ability to alter config encoder output settings.

func WithComments

func WithComments(flag CommentsFlag) Option

WithComments enables comments in the encoder.

func WithCommentsMap

func WithCommentsMap(m map[string]string) Option

WithCommentsMap enables comments from map.

func WithOmitEmpty

func WithOmitEmpty(value bool) Option

WithOmitEmpty toggles omitempty handling.

type Options

type Options struct {
	CommentsFlag CommentsFlag
	OmitEmpty    bool
	CommentsMap  map[string]string
}

Options defines encoder config.