codec

package

v0.3.10 Latest Latest Go to latest Published: Dec 18, 2020 License: MIT Imports: 5 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

View Source

const (
	MetaInfoSize = keySize + valueSize + checksumSize
)

This section is empty.

func DecodeEntry(b []byte, e *internal.Entry, maxKeySize uint32, maxValueSize uint64) error

DecodeEntry decodes a serialized entry

func IsCorruptedData(err error) bool

IsCorruptedData indicates if the error correspondes to possible data corruption

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

Decoder wraps an underlying io.Reader and allows you to stream Entry decodings on it.

func NewDecoder(r io.Reader, maxKeySize uint32, maxValueSize uint64) *Decoder

NewDecoder creates a streaming Entry decoder.

func (d *Decoder) Decode(v *internal.Entry) (int64, error)

Decode decodes the next Entry from the current stream

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

Encoder wraps an underlying io.Writer and allows you to stream Entry encodings on it.

func NewEncoder(w io.Writer) *Encoder

NewEncoder creates a streaming Entry encoder.

func (e *Encoder) Encode(msg internal.Entry) (int64, error)

Encode takes any Entry and streams it to the underlying writer. Messages are framed with a key-length and value-length prefix.