zlib

package

v0.0.0-...-4a8f785 Latest Latest Go to latest Published: Dec 6, 2021 License: Apache-2.0 Imports: 4 Imported by: 1

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

github.com/creachadair/ffs

Links

Open Source Insights

Documentation ¶

Overview ¶

Package zlib implements the encoded.Codec interface to apply zlib compression to blobs.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Codec ¶

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

A Codec implements the encoded.Codec interface to provide zlib compression of blob data. A zero value is ready for use, but performs no compression. For most uses prefer NewCodec.

func NewCodec ¶

func NewCodec(level Level) Codec

NewCodec returns a Codec using the specified compression level. Note that a zero level means no compression, not default compression.

func (Codec) Decode ¶

func (c Codec) Decode(w io.Writer, src []byte) error

Decode decompresses src via zlib and writes it to w.

func (Codec) DecodedLen ¶

func (c Codec) DecodedLen(src []byte) (int, error)

DecodedLen reports the decoded length of src.

func (Codec) Encode ¶

func (c Codec) Encode(w io.Writer, src []byte) error

Encode compresses src via zlib and writes it to w.

type Level ¶

type Level int

Level determines the compression level to use.

const (
	LevelNone     Level = flate.NoCompression
	LevelFastest  Level = flate.BestSpeed
	LevelSmallest Level = flate.BestCompression
	LevelDefault  Level = flate.DefaultCompression
)

Compression level constants forwarded from compress/flate.

Source Files ¶

View all Source files

zlib.go

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