Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

archive

package

Go to main page

Versions in this module

v1

v1.0.0

Mar 14, 2026

Changes in this version

+ const DefaultCompressionLevel

+ const HeaderSize

+ var Magic = [4]byte

+ func Encode(dst io.WriteSeeker, data []byte, opts ...WriterOption) error

+ func ReadAll(r io.ReadSeeker) ([]byte, error)

+ type Header struct

+ CompressedLength uint64

+ HeaderLength uint32

+ Length uint64

+ Magic [4]byte

+ func NewHeader(uncompressedSize, compressedSize uint64) *Header

+ func (h *Header) DecodeFrom(data []byte)

+ func (h *Header) EncodeTo(buf []byte)

+ func (h *Header) MarshalBinary() ([]byte, error)

+ func (h *Header) Size() int

+ func (h *Header) UnmarshalBinary(data []byte) error

+ func (h *Header) Validate() error

+ type Reader struct

+ func NewReader(r io.ReadSeeker) (*Reader, error)

+ func (r *Reader) Close() error

+ func (r *Reader) CompressedLength() int

+ func (r *Reader) Header() *Header

+ func (r *Reader) Length() int

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

+ type Writer struct

+ func NewWriter(dst io.WriteSeeker, uncompressedSize uint64, opts ...WriterOption) (*Writer, error)

+ func (w *Writer) Close() error

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

+ type WriterOption func(*Writer)

+ func WithCompressionLevel(level int) WriterOption

v0

v0.2.0

Mar 14, 2026