package
2.0.0-20250217040219-9c7962d519d4
Repository: https://github.com/dev4mobile/mupdf.git
Documentation: pkg.go.dev

# README

This is a Snappy library for the Go programming language that has been modified to work with Apple files, which fail to set CRC checks and stream identifiers. This version is a total hack, so if you want to use snappy for other projects DO NOT USE THIS VERSION. Use the proper version as per below:

To download and install from source: $ go get code.google.com/p/snappy-go/snappy

Unless otherwise noted, the Snappy-Go source files are distributed under the BSD-style license found in the LICENSE file.

Contributions should follow the same procedure as for the Go project: http://golang.org/doc/contribute.html

# Functions

Decode returns the decoded form of src.
DecodedLen returns the length of the decoded block.
Encode returns the encoded form of src.
MaxEncodedLen returns the maximum length of a snappy block, given its uncompressed length.
NewReader returns a new Reader that decompresses from r, using the framing format described at https://code.google.com/p/snappy/source/browse/trunk/framing_format.txt.
NewWriter returns a new Writer that compresses to w, using the framing format described at https://code.google.com/p/snappy/source/browse/trunk/framing_format.txt.

# Variables

ErrCorrupt reports that the input is invalid.
ErrUnsupported reports that the input isn't supported.

# Structs

Reader is an io.Reader than can read Snappy-compressed bytes.
Writer is an io.Writer than can write Snappy-compressed bytes.