compress

Documentation

Overview

Package compress implements compression support.

Index

• func MethodStrings() []string
• type Method
  • func MethodString(s string) (Method, error)
  • func MethodValues() []Method
  • func (i Method) IsAMethod() bool
  • func (i Method) String() string
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Read(p []byte) (n int, err error)
• type Writer
  • func NewWriter() *Writer
  • func (w *Writer) Compress(buf []byte) error

Functions

func MethodStrings

func MethodStrings() []string

MethodStrings returns a slice of all String values of the enum

Types

type Method

type Method byte

Method is compression codec.

const (
	None Method = 0x02
	LZ4  Method = 0x82
	ZSTD Method = 0x90
)

Possible compression methods.

func MethodString

func MethodString(s string) (Method, error)

MethodString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func MethodValues

func MethodValues() []Method

MethodValues returns all values of the enum

func (Method) IsAMethod

func (i Method) IsAMethod() bool

IsAMethod returns "true" if the value is listed in the enum definition. "false" otherwise

func (Method) String

func (i Method) String() string

type Reader

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

Reader decodes compressed blocks.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns new *Reader from r.

func (*Reader) Read

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

Read implements io.Reader.

type Writer

type Writer struct {
	Data []byte
	// contains filtered or unexported fields
}

Writer encodes compressed blocks.

func NewWriter

func NewWriter() *Writer

func (*Writer) Compress

func (w *Writer) Compress(buf []byte) error

Compress buf into Data.