compression

Documentation

Index

• Constants
• Variables
• func DefaultFilter(request *http.Request) bool
• func New(options Options) xhttp.Middleware
• type Algorithm
  • func Brotli() Algorithm
  • func BrotliLevel(level int) Algorithm
  • func Deflate() Algorithm
  • func DeflateLevel(level int) Algorithm
  • func Gzip() Algorithm
  • func GzipLevel(level int) Algorithm
  • func Zstd() Algorithm
  • func ZstdLevel(level zstd.EncoderLevel) Algorithm
• type Filter
• type Options

Constants

const (
	CompressMinSizeDefault = 1024
)

Variables

var Default = New(Options{})

Get the default compression middleware. All options are defaulted.

Functions

func DefaultFilter

func DefaultFilter(request *http.Request) bool

Default filter function which applies compression to text/* and application/* content types.

func New

func New(options Options) xhttp.Middleware

Create a Middleware that compresses response automatically based on content encoding, type, and length.

Types

type Algorithm

type Algorithm struct {
	// Name of an encoding algorithm which must match an Accept-Encoding value
	// exactly.
	Name string
	// Return a WriteCloser that wraps the provided io.Writer with compression.
	GetWriter func(io.Writer) (io.WriteCloser, error)
}

Compression algorithm definition.

func Brotli

func Brotli() Algorithm

Brotli compression algorithm with default compression level.

func BrotliLevel

func BrotliLevel(level int) Algorithm

Brotli compression algorithm with custom compression level.

func Deflate

func Deflate() Algorithm

Deflate compression algorithm with default compression level.

func DeflateLevel

func DeflateLevel(level int) Algorithm

Deflate compression algorithm with custom compression level.

func Gzip

func Gzip() Algorithm

Gzip compression algorithm with default compression level.

func GzipLevel

func GzipLevel(level int) Algorithm

Gzip compression algorithm with custom compression level.

func Zstd

func Zstd() Algorithm

Zstd compression algorithm with default compression level.

func ZstdLevel

func ZstdLevel(level zstd.EncoderLevel) Algorithm

Zstd compression algorithm with custom compression level.

type Filter

type Filter func(request *http.Request) bool

type Options

type Options struct {
	// Filter requests that are eligible for compression. If nil, all text/* and
	// application/* types are compressed.
	Filter Filter
	// Minimum size in bytes to trigger compression. If zero,
	// CompressMinSizeDefault is used.
	MinSize int
	// Supported compression Algorithm slice in order of preference. If empty,
	// Brotli, Gzip, and Deflate are supported.
	Algorithms []Algorithm
}

Compression middleware options.