compress

package module

v0.1.1 Latest Latest Go to latest Published: Jul 15, 2026 License: BSD-3-Clause Imports: 9 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luxfi/compress

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Compressor
- func NewGzipCompressor(maxSize int64) (Compressor, error)
- func NewNoCompressor() Compressor
type Type
- func TypeFromString(s string) (Type, error)
- func (t Type) MarshalJSON() ([]byte, error)
- func (t Type) String() string
type ZstdCompressor
- func NewZstdCompressor(maxSize int64) (*ZstdCompressor, error)
- func NewZstdCompressorWithLevel(maxSize int64, level zstd.EncoderLevel) (*ZstdCompressor, error)
- func (z *ZstdCompressor) Compress(msg []byte) ([]byte, error)
- func (z *ZstdCompressor) Decompress(msg []byte) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidMaxSizeCompressor = errors.New("invalid compressor max size")
	ErrDecompressedMsgTooLarge  = errors.New("decompressed msg too large")
	ErrMsgTooLarge              = errors.New("msg too large to be compressed")
)

Functions ¶

This section is empty.

Types ¶

type Compressor ¶

type Compressor interface {
	Compress([]byte) ([]byte, error)
	Decompress([]byte) ([]byte, error)
}

Compressor compress and decompresses messages. Decompress is the inverse of Compress. Decompress(Compress(msg)) == msg.

func NewGzipCompressor ¶

func NewGzipCompressor(maxSize int64) (Compressor, error)

NewGzipCompressor returns a new gzip Compressor that compresses

func NewNoCompressor ¶

func NewNoCompressor() Compressor

type Type ¶

type Type byte

const (
	TypeNone Type = iota + 1
	TypeZstd
)

func TypeFromString ¶

func TypeFromString(s string) (Type, error)

func (Type) MarshalJSON ¶

func (t Type) MarshalJSON() ([]byte, error)

func (Type) String ¶

func (t Type) String() string

type ZstdCompressor ¶

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

ZstdCompressor implements Compressor using zstd compression

func NewZstdCompressor ¶

func NewZstdCompressor(maxSize int64) (*ZstdCompressor, error)

func NewZstdCompressorWithLevel ¶

func NewZstdCompressorWithLevel(maxSize int64, level zstd.EncoderLevel) (*ZstdCompressor, error)

func (*ZstdCompressor) Compress ¶

func (z *ZstdCompressor) Compress(msg []byte) ([]byte, error)

func (*ZstdCompressor) Decompress ¶

func (z *ZstdCompressor) Decompress(msg []byte) ([]byte, error)

Source Files ¶

View all Source files

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