gzip

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package gzip provides gzip compression support for omnistorage.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CompressionLevel

type CompressionLevel int

CompressionLevel represents gzip compression levels.

const (
	// NoCompression provides no compression.
	NoCompression CompressionLevel = gzip.NoCompression
	// BestSpeed provides fastest compression.
	BestSpeed CompressionLevel = gzip.BestSpeed
	// BestCompression provides best compression ratio.
	BestCompression CompressionLevel = gzip.BestCompression
	// DefaultCompression provides a balance of speed and compression.
	DefaultCompression CompressionLevel = gzip.DefaultCompression
	// HuffmanOnly uses Huffman encoding only.
	HuffmanOnly CompressionLevel = gzip.HuffmanOnly
)

type Reader

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

Reader wraps an io.ReadCloser with gzip decompression.

func NewReader

func NewReader(r io.ReadCloser) (*Reader, error)

NewReader creates a new gzip reader that decompresses data from the underlying reader.

func (*Reader) Close

func (r *Reader) Close() error

Close closes both the gzip reader and the underlying reader.

func (*Reader) Header

func (r *Reader) Header() gzip.Header

Header returns the gzip header.

func (*Reader) Read

func (r *Reader) Read(p []byte) (n int, err error)

Read reads decompressed data from the underlying reader.

type Writer

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

Writer wraps an io.WriteCloser with gzip compression.

func NewWriter

func NewWriter(w io.WriteCloser) (*Writer, error)

NewWriter creates a new gzip writer with default compression level.

func NewWriterLevel

func NewWriterLevel(w io.WriteCloser, level CompressionLevel) (*Writer, error)

NewWriterLevel creates a new gzip writer with the specified compression level.

func (*Writer) Close

func (w *Writer) Close() error

Close flushes any remaining data and closes both the gzip writer and the underlying writer.

func (*Writer) Flush

func (w *Writer) Flush() error

Flush flushes any pending compressed data.

func (*Writer) Write

func (w *Writer) Write(p []byte) (n int, err error)

Write writes compressed data to the underlying writer.

Jump to

Keyboard shortcuts

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