compress

package module

v1.0.5 Latest Latest Go to latest Published: Apr 8, 2023 License: MIT Imports: 4 Imported by: 5

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

Repository

bitbucket.org/pcastools/compress

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Register(t Type, rf func(io.Reader) (io.ReadCloser, error), ...)
type Type

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotAvailable = errors.New("Compression type is unavailable (not linked into the binary)")
)

Common errors.

Functions ¶

func Register ¶

func Register(t Type, rf func(io.Reader) (io.ReadCloser, error), wf func(io.Writer) (io.WriteCloser, error))

Register registers the given compression type. Intended to be called from the compression type's init method.

Types ¶

type Type ¶

type Type uint8

Type indicates the compression format, as implemented in another package.

const (
	None   Type = iota
	Snappy      // import _ "bitbucket.org/pcastools/compress/snappy"
	Gzip        // import _ "bitbucket.org/pcastools/compress/gzip"
	Zlib        // import _ "bitbucket.org/pcastools/compress/zlib"
	Zstd        // import _ "bitbucket.org/pcastools/compress/zstd"
	S2          // import _ "bitbucket.org/pcastools/compress/s2"

)

The supported compression formats.

func (Type) Available ¶

func (t Type) Available() bool

Available reports whether the given compression type is linked into the binary.

func (Type) NewReader ¶

func (t Type) NewReader(r io.Reader) (io.ReadCloser, error)

NewReader creates a new reader for this compression type, reading from the given io.Reader r. It is the caller's responsibility to call Close on the reader when done.

func (Type) NewWriter ¶

func (t Type) NewWriter(w io.Writer) (io.WriteCloser, error)

NewWriter creates a new writer for this compression type. Writes to the returned writer will be compressed and written to w. It is the caller's responsibility to call Close on the writer when done.

func (Type) String ¶

func (t Type) String() string

String returns a string description of this compression type.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gzip
internal
compresstest
s2
snappy
zlib
zstd

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL