codec

package

v1.1.0 Latest Latest Go to latest Published: Apr 5, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

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

Package codec provides the interface definitions for encoding types into their byte slice representation, and decoding a byte slice into types.

Package json provides a JSON codec with an encoder/decoder.

This section is empty.

This section is empty.

This section is empty.

type Codec interface {
	Encoder
	Decoder
}

Codec is a composite of Encoder and Decoder.

type Decoder interface {
	// Decode decodes a byte slice representation into its Go type.
	Decode(in []byte, out any) error
}

Decoder decodes a byte slice representation into its Go type.

func RecordDecodedBytes(d Decoder, m metric.Int64Counter) Decoder

RecordDecodedBytes decorates a decoder with a metric that records the bytes that have been decoded.

type Encoder interface {
	// Encode encodes a type into its byte slice representation.
	Encode(in any) ([]byte, error)
}

Encoder encodes a type into its byte slice representation.

func RecordEncodedBytes(e Encoder, m metric.Int64Counter) Encoder

RecordEncodedBytes decorates an encoder with a metric that records the bytes that have been encoded.

type JSON struct{}

JSON wraps the standard json library.

func (j JSON) Decode(in []byte, out any) error

Decode decodes a JSON-encoded byte slice into its type.

func (j JSON) Encode(in any) ([]byte, error)

Encode encodes a type into the JSON byte slice representation.

type VTProto struct{}

VTProto is a composite of Encoder and Decoder

func (v VTProto) Decode(in []byte, out any) error

Decode decodes a byte slice into vtprotoMessage type.

func (v VTProto) Encode(in any) ([]byte, error)

Encode encodes vtprotoMessage type into byte slice