marshaller

Documentation

Index

• Variables
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Create(kind string) (Marshaller, error)
  • func (f *Factory) Register(kind string, m Marshaller)
• type GOB
  • func NewGOB() *GOB
  • func (m *GOB) Marshal(v any) ([]byte, error)
  • func (m *GOB) Unmarshal(data []byte, v any) error
• type JSON
  • func NewJSON() *JSON
  • func (m *JSON) Marshal(v any) ([]byte, error)
  • func (m *JSON) Unmarshal(data []byte, v any) error
• type Marshaller
• 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(NewProto),
	fx.Provide(NewJSON),
	fx.Provide(NewTOML),
	fx.Provide(NewYAML),
	fx.Provide(NewFactory),
)

Module for fx.

Types

type Factory

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

Factory of marshaller.

func NewFactory

func NewFactory() *Factory

NewFactory for marshaller.

func (*Factory) Create

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

Create from kind.

func (*Factory) Register

func (f *Factory) Register(kind string, m Marshaller)

Register kind and marshaller.

type GOB

type GOB struct{}

GOB for marshaller.

func NewGOB

func NewGOB() *GOB

NewJSON for marshaller.

func (*GOB) Marshal

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

func (*GOB) Unmarshal

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

type JSON

type JSON struct{}

JSON for marshaller.

func NewJSON

func NewJSON() *JSON

NewJSON for marshaller.

func (*JSON) Marshal

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

func (*JSON) Unmarshal

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

type Marshaller

type Marshaller interface {
	// Marshal value.
	Marshal(v any) ([]byte, error)

	// Unmarshal data to value.
	Unmarshal(data []byte, v any) error
}

Marshaller allows to have different ways to marshal/unmarshal.

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