packed

package

v2.18.2+incompatible Latest Latest Go to latest Published: May 13, 2021 License: MIT Imports: 3 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 packed provides functions to read and write the "packed" compression scheme described at https://capnproto.org/encoding.html#packing.

This section is empty.

This section is empty.

func Pack(dst, src []byte) []byte

Pack appends the packed version of src to dst and returns the resulting slice. len(src) must be a multiple of 8 or Pack panics.

func Unpack(dst, src []byte) ([]byte, error)

Unpack appends the unpacked version of src to dst and returns the resulting slice.

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

A Reader decompresses a packed byte stream.

func NewReader(r *bufio.Reader) *Reader

NewReader returns a reader that decompresses a packed stream from r.

func (r *Reader) Read(p []byte) (n int, err error)

Read reads up to len(p) bytes into p. This will decompress whole words at a time, so mixing calls to Read and ReadWord may lead to bytes missing.

func (r *Reader) ReadWord(p []byte) error

ReadWord decompresses the next word from the underlying stream.