codecs

package

v0.5.0 Latest Latest Go to latest Published: Aug 18, 2022 License: MIT Imports: 6 Imported by: 1

Details

This section is empty.

View Source

var ErrUnknownCodec = errors.New("unknown codec")

ErrUnknownCodec is returned when no codec is found for the given name.

This section is empty.

type Codec[Q, R any] interface {
	Encode(Q) ([]byte, error)
	Decode([]byte, *R) error
	Name() string
}

Codec defines the interface for a two way conversion between Q and R.

func ForName[Q, R any](name string) (Codec[Q, R], error)

ForName returns the codec for the given name or ErrUnknownCodec if no codec is found.

type GobCodec[Q, R any] struct{}

GobCodec is a Codec that uses gob as the underlying format.

func (c GobCodec[Q, R]) Decode(b []byte, r *R) error

func (c GobCodec[Q, R]) Encode(q Q) ([]byte, error)

func (c GobCodec[Q, R]) Name() string

type JSONCodec[Q, R any] struct{}

JSONCodec is a Codec that uses JSON as the underlying format.

func (c JSONCodec[Q, R]) Decode(b []byte, r *R) error

func (c JSONCodec[Q, R]) Encode(q Q) ([]byte, error)

func (c JSONCodec[Q, R]) Name() string

type TOMLCodec[Q, R any] struct{}

TOMLCodec is a Codec that uses TOML as the underlying format.

func (c TOMLCodec[Q, R]) Decode(b []byte, r *R) error

func (c TOMLCodec[Q, R]) Encode(q Q) ([]byte, error)

func (c TOMLCodec[Q, R]) Name() string