gzip

Documentation

Index

• Constants
• Variables
• func Gzip(level int, options ...Option) http.HandlerFunc
• func GzipBody(r *http.Request) ([]byte, error)
• type ExcludedExtensions
  • func NewExcludedExtensions(extensions []string) ExcludedExtensions
  • func (e ExcludedExtensions) Contains(target string) bool
• type ExcludedPaths
  • func NewExcludedPaths(paths []string) ExcludedPaths
  • func (e ExcludedPaths) Contains(requestURI string) bool
• type ExcludedPathsRegex
  • func NewExcludedPathsRegex(regexes []string) ExcludedPathsRegex
  • func (e ExcludedPathsRegex) Contains(requestURI string) bool
• type Option
  • func WithExcludedExtensions(args []string) Option
  • func WithExcludedPaths(args []string) Option
  • func WithExcludedPathsRegexes(args []string) Option
  • func WithHandler(decompressFn http.HandlerFunc) Option
• type Options

Constants

const (
	BestCompression    = gzip.BestCompression
	BestSpeed          = gzip.BestSpeed
	DefaultCompression = gzip.DefaultCompression
	NoCompression      = gzip.NoCompression
)

Variables

var (
	DefaultExcludedExtensions = NewExcludedExtensions([]string{
		".png", ".gif", ".jpeg", ".jpg",
	})
	DefaultOptions = &Options{
		ExcludedExtensions: DefaultExcludedExtensions,
	}
)

Functions

func Gzip

func Gzip(level int, options ...Option) http.HandlerFunc

func GzipBody

func GzipBody(r *http.Request) ([]byte, error)

Types

type ExcludedExtensions

type ExcludedExtensions map[string]bool

Using map for better lookup performance

func NewExcludedExtensions

func NewExcludedExtensions(extensions []string) ExcludedExtensions

func (ExcludedExtensions) Contains

func (e ExcludedExtensions) Contains(target string) bool

type ExcludedPaths

type ExcludedPaths []string

func NewExcludedPaths

func NewExcludedPaths(paths []string) ExcludedPaths

func (ExcludedPaths) Contains

func (e ExcludedPaths) Contains(requestURI string) bool

type ExcludedPathsRegex

type ExcludedPathsRegex []*regexp.Regexp

func NewExcludedPathsRegex

func NewExcludedPathsRegex(regexes []string) ExcludedPathsRegex

func (ExcludedPathsRegex) Contains

func (e ExcludedPathsRegex) Contains(requestURI string) bool

type Option

type Option func(*Options)

func WithExcludedExtensions

func WithExcludedExtensions(args []string) Option

func WithExcludedPaths

func WithExcludedPaths(args []string) Option

func WithExcludedPathsRegexes

func WithExcludedPathsRegexes(args []string) Option

func WithHandler

func WithHandler(decompressFn http.HandlerFunc) Option

type Options

type Options struct {
	ExcludedExtensions ExcludedExtensions
	ExcludedPaths      ExcludedPaths
	ExcludedPathsRegex ExcludedPathsRegex
	Handler            http.HandlerFunc
}