Package: github.com/golang/snappy

package snappy Import Path github.com/golang/snappy (on go.dev) Dependency Relation imports 4 packages, and imported by 2 packages

Involved Source Files decode.go decode_asm.go encode.go encode_asm.go d snappy.go Package snappy implements the Snappy compression format. It aims for very high speeds and reasonable compression. There are actually two Snappy formats: block and stream. They are related, but different: trying to decompress block-compressed data as a Snappy stream will fail, and vice versa. The block format is the Decode and Encode functions and the stream format is the Reader and Writer types. The block format, the more common case, is used when the complete size (the number of bytes) of the original data is known upfront, at the time compression starts. The stream format, also known as the framing format, is for when that isn't always true. The canonical, C++ implementation is at https://github.com/google/snappy and it only implements the block format. decode_amd64.s encode_amd64.s

Package-Level Functions (total 7)

func Decode(dst, src []byte) ([]byte, error) Decode returns the decoded form of src. The returned slice may be a sub- slice of dst if dst was large enough to hold the entire decoded block. Otherwise, a newly allocated slice will be returned. The dst and src must not overlap. It is valid to pass a nil dst. Decode handles the Snappy block format, not the Snappy stream format.

func DecodedLen(src []byte) (int, error) DecodedLen returns the length of the decoded block.

func Encode(dst, src []byte) []byte Encode returns the encoded form of src. The returned slice may be a sub- slice of dst if dst was large enough to hold the entire encoded block. Otherwise, a newly allocated slice will be returned. The dst and src must not overlap. It is valid to pass a nil dst. Encode handles the Snappy block format, not the Snappy stream format.

func MaxEncodedLen(srcLen int) int MaxEncodedLen returns the maximum length of a snappy block, given its uncompressed length. It will return a negative value if srcLen is too large to encode.

func NewBufferedWriter(w io.Writer) *Writer NewBufferedWriter returns a new Writer that compresses to w, using the framing format described at https://github.com/google/snappy/blob/master/framing_format.txt The Writer returned buffers writes. Users must call Close to guarantee all data has been forwarded to the underlying io.Writer. They may also call Flush zero or more times before calling Close.

func NewReader(r io.Reader) *Reader NewReader returns a new Reader that decompresses from r, using the framing format described at https://github.com/google/snappy/blob/master/framing_format.txt

func NewWriter(w io.Writer) *Writer NewWriter returns a new Writer that compresses to w. The Writer returned does not buffer writes. There is no need to Flush or Close such a Writer. Deprecated: the Writer returned is not suitable for many small writes, only for few large writes. Use NewBufferedWriter instead, which is efficient regardless of the frequency and shape of the writes, and remember to Close that Writer when done.

Package-Level Variables (total 3)

var ErrCorrupt error ErrCorrupt reports that the input is invalid.

var ErrTooLarge error ErrTooLarge reports that the uncompressed length is too large.

var ErrUnsupported error ErrUnsupported reports that the input isn't supported.