compressors

Documentation

Index

• Constants
• func NewCompressorByExt(ext string) (comp mw.Middleware, err error)
• type Flate
  • func NewFlate(level int) Flate
  • func (Flate) Name() string
  • func (Flate) Reader(path string, r io.Reader, _ os.FileInfo) (io.ReadCloser, error)
  • func (f Flate) Writer(path string, w io.Writer) (io.WriteCloser, error)
• type Gzip
  • func NewGzip(level int) Gzip
  • func (Gzip) Name() string
  • func (Gzip) Reader(path string, r io.Reader, _ os.FileInfo) (io.ReadCloser, error)
  • func (f Gzip) Writer(path string, w io.Writer) (io.WriteCloser, error)
• type Snappy
  • func NewSnappy() Snappy
  • func (Snappy) Name() string
  • func (Snappy) Reader(path string, r io.Reader, _ os.FileInfo) (io.ReadCloser, error)
  • func (Snappy) Writer(path string, w io.Writer) (io.WriteCloser, error)

Constants

const (

	// ErrInvalidCompressor is returned when an invalid compressor is provided to NewCompressorByExt
	ErrInvalidCompressor = oerrs.String("invalid compressor")

	// ErrRawCompressor is returned when a raw compressor is provided to NewCompressorByExt
	ErrRawCompressor = oerrs.String("raw compressor provided")
)

Functions

func NewCompressorByExt

func NewCompressorByExt(ext string) (comp mw.Middleware, err error)

NewCompressorByExt returns a compressor middleware by extension

Types

type Flate

type Flate struct {
	Level int
}

func NewFlate

func NewFlate(level int) Flate

func (Flate) Name

func (Flate) Name() string

func (Flate) Reader

func (Flate) Reader(path string, r io.Reader, _ os.FileInfo) (io.ReadCloser, error)

func (Flate) Writer

func (f Flate) Writer(path string, w io.Writer) (io.WriteCloser, error)

type Gzip

type Gzip struct {
	Level int
}

func NewGzip

func NewGzip(level int) Gzip

func (Gzip) Name

func (Gzip) Name() string

func (Gzip) Reader

func (Gzip) Reader(path string, r io.Reader, _ os.FileInfo) (io.ReadCloser, error)

func (Gzip) Writer

func (f Gzip) Writer(path string, w io.Writer) (io.WriteCloser, error)

type Snappy

type Snappy struct{}

Snappy is for the Google-created snappy compression type

func NewSnappy

func NewSnappy() Snappy

NewSnappy returns a new instance of Snappy

func (Snappy) Name

func (Snappy) Name() string

Name returns the name of the compressor type

func (Snappy) Reader

func (Snappy) Reader(path string, r io.Reader, _ os.FileInfo) (io.ReadCloser, error)

Reader returns a new Snappy reader

func (Snappy) Writer

func (Snappy) Writer(path string, w io.Writer) (io.WriteCloser, error)

Writer returns a new Snappy writer