marshaller

Documentation

Index

• Variables
• type Factory
  • func NewFactory(params FactoryParams) *Factory
  • func (f *Factory) Create(kind string) (Marshaller, error)
• type FactoryParams
• type Marshaller
• type MsgPack
  • func NewMsgPack() *MsgPack
  • func (m *MsgPack) Marshal(v any) ([]byte, error)
  • func (m *MsgPack) Unmarshal(data []byte, v any) error
• type Proto
  • func NewProto() *Proto
  • func (m *Proto) Marshal(v any) ([]byte, error)
  • func (m *Proto) Unmarshal(data []byte, v any) error
• type TOML
  • func NewTOML() *TOML
  • func (m *TOML) Marshal(v any) ([]byte, error)
  • func (m *TOML) Unmarshal(data []byte, v any) error
• type YAML
  • func NewYAML() *YAML
  • func (m *YAML) Marshal(v any) ([]byte, error)
  • func (m *YAML) Unmarshal(data []byte, v any) error

Variables

var ErrInvalidKind = errors.New("invalid kind")

ErrInvalidKind for marshaller.

var Module = fx.Options(
	fx.Provide(NewMsgPack),
	fx.Provide(NewProto),
	fx.Provide(NewYAML),
	fx.Provide(NewTOML),
	fx.Provide(NewFactory),
)

Module for fx.

Types

type Factory

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

Factory of marshaller.

func NewFactory

func NewFactory(params FactoryParams) *Factory

NewFactory for marshaller.

func (*Factory) Create

func (f *Factory) Create(kind string) (Marshaller, error)

Create from kind.

type FactoryParams

type FactoryParams struct {
	fx.In

	YAML *YAML
	TOML *TOML
}

FactoryParams for marshaller.

type Marshaller

type Marshaller interface {
	Marshal(v any) ([]byte, error)
	Unmarshal(data []byte, v any) error
}

Compressor allows to have different ways to marshal/unmarshal.

type MsgPack

type MsgPack struct{}

MsgPack for marshaller.

func NewMsgPack

func NewMsgPack() *MsgPack

NewMsgPack for marshaller.

func (*MsgPack) Marshal

func (m *MsgPack) Marshal(v any) ([]byte, error)

func (*MsgPack) Unmarshal

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

type Proto

type Proto struct{}

Proto for marshaller.

func NewProto

func NewProto() *Proto

NewProto for marshaller.

func (*Proto) Marshal

func (m *Proto) Marshal(v any) ([]byte, error)

func (*Proto) Unmarshal

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

type TOML

type TOML struct{}

TOML for marshaller.

func NewTOML

func NewTOML() *TOML

NewTOML for marshaller.

func (*TOML) Marshal

func (m *TOML) Marshal(v any) ([]byte, error)

func (*TOML) Unmarshal

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

type YAML

type YAML struct{}

YAML for marshaller.

func NewYAML

func NewYAML() *YAML

NewYAML for marshaller.

func (*YAML) Marshal

func (m *YAML) Marshal(v any) ([]byte, error)

func (*YAML) Unmarshal

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