encoding

Documentation

Index

• Variables
• type Encoder
• type Map
  • func NewMap(params MapParams) *Map
  • func (f *Map) Get(kind string) Encoder
  • func (f *Map) Register(kind string, enc Encoder)
• type MapParams

Variables

var Module = fx.Options(
	fx.Provide(proto.NewBinary),
	fx.Provide(proto.NewText),
	fx.Provide(proto.NewJSON),
	fx.Provide(json.NewEncoder),
	fx.Provide(toml.NewEncoder),
	fx.Provide(yaml.NewEncoder),
	fx.Provide(gob.NewEncoder),
	fx.Provide(NewMap),
)

Module for fx.

Types

type Encoder

type Encoder interface {
	// Encode any to a writer.
	Encode(w io.Writer, e any) error

	// Decode any from a reader.
	Decode(r io.Reader, e any) error
}

Encoder allows different types of encoding/decoding.

type Map

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

Map of encoding.

func NewMap

func NewMap(params MapParams) *Map

NewMap for encoding.

func (*Map) Get

func (f *Map) Get(kind string) Encoder

Get from kind.

func (*Map) Register

func (f *Map) Register(kind string, enc Encoder)

Register kind and encoder.

type MapParams

type MapParams struct {
	fx.In

	JSON        *json.Encoder
	YAML        *yaml.Encoder
	TOML        *toml.Encoder
	ProtoBinary *proto.Binary
	ProtoText   *proto.Text
	ProtoJSON   *proto.JSON
	GOB         *gob.Encoder
}

MapParams for encoding.