gzip

Documentation

Overview

Package gzip provides a simple middleware layer that performs gzip compression on the response.

Index

• Constants
• type Config
• type ExtFilter
  • func DefaultExtFilter() ExtFilter
  • func (e ExtFilter) ShouldCompress(r *http.Request) bool
• type Filter
• type Gzip
  • func (g Gzip) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type PathFilter
  • func (p PathFilter) ShouldCompress(r *http.Request) bool
• type Set
  • func (s Set) Add(value string)
  • func (s Set) Contains(value string) bool
  • func (s Set) ContainsFunc(f func(string) bool) bool
  • func (s Set) Remove(value string)

Constants

const ExtWildCard = "*"

ExtWildCard is the wildcard for extensions.

Types

type Config

type Config struct {
	Filters []Filter // Filters to use
	Level   int      // Compression level
}

Config holds the configuration for Gzip middleware

type ExtFilter

type ExtFilter struct {
	// Exts is the file name extensions to accept
	Exts Set
}

ExtFilter is Filter for file name extensions.

func DefaultExtFilter

func DefaultExtFilter() ExtFilter

DefaultExtFilter creates an ExtFilter with default extensions.

func (ExtFilter) ShouldCompress

func (e ExtFilter) ShouldCompress(r *http.Request) bool

ShouldCompress checks if the request file extension matches any of the registered extensions. It returns true if the extension is found and false otherwise.

type Filter

type Filter interface {
	// ShouldCompress tells if gzip compression
	// should be done on the request.
	ShouldCompress(*http.Request) bool
}

Filter determines if a request should be gzipped.

type Gzip

type Gzip struct {
	Next    middleware.Handler
	Configs []Config
}

Gzip is a middleware type which gzips HTTP responses. It is imperative that any handler which writes to a gzipped response specifies the Content-Type, otherwise some clients will assume application/x-gzip and try to download a file.

func (Gzip) ServeHTTP

func (g Gzip) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

ServeHTTP serves a gzipped response if the client supports it.

type PathFilter

type PathFilter struct {
	// IgnoredPaths is the paths to ignore
	IgnoredPaths Set
}

PathFilter is Filter for request path.

func (PathFilter) ShouldCompress

func (p PathFilter) ShouldCompress(r *http.Request) bool

ShouldCompress checks if the request path matches any of the registered paths to ignore. It returns false if an ignored path is found and true otherwise.

type Set

type Set map[string]struct{}

Set stores distinct strings.

func (Set) Add

func (s Set) Add(value string)

Add adds an element to the set.

func (Set) Contains

func (s Set) Contains(value string) bool

Contains check if the set contains value.

func (Set) ContainsFunc

func (s Set) ContainsFunc(f func(string) bool) bool

ContainsFunc is similar to Contains. It iterates all the elements in the set and passes each to f. It returns true on the first call to f that returns true and false otherwise.

func (Set) Remove

func (s Set) Remove(value string)

Remove removes an element from the set.