packed

Documentation

Overview

Package packed provides functions to read and write the "packed" compression scheme described at https://capnproto.org/encoding.html#packing.

Index

• func Pack(dst, src []byte) []byte
• func Unpack(dst, src []byte) ([]byte, error)
• type Reader
  • func NewReader(r *bufio.Reader) *Reader
  • func (r *Reader) Read(p []byte) (n int, err error)
  • func (r *Reader) ReadWord(p []byte) error

Functions

func Pack

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

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

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

Types

type Reader

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

A Reader decompresses a packed byte stream.

func NewReader

func NewReader(r *bufio.Reader) *Reader

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

func (*Reader) Read

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 (*Reader) ReadWord

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

ReadWord decompresses the next word from the underlying stream.