codecs

package

v0.9.0 Latest Latest Go to latest Published: Apr 3, 2024 License: MIT Imports: 5 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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 interface {
	Encode(any) ([]byte, error)
	Decode([]byte, any) error
	Name() string
}

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

func ForName(name string) (Codec, error)

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

type JSONCodec struct{}

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

func (c JSONCodec) Decode(b []byte, r any) error

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

func (c JSONCodec) Name() string

type TOMLCodec struct{}

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

func (c TOMLCodec) Decode(b []byte, r any) error

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

func (c TOMLCodec) Name() string