rkgingzip

Documentation

Index

• Constants
• func Middleware(opts ...Option) gin.HandlerFunc
• type Option
  • func WithEntryNameAndType(entryName, entryType string) Option
  • func WithLevel(level string) Option
  • func WithPathToIgnore(prefix ...string) Option
  • func WithSkipper(skip Skipper) Option
• type Skipper

Constants

const (

	// NoCompression copied from gzip.NoCompression
	NoCompression = "noCompression"
	// BestSpeed copied from gzip.BestSpeed
	BestSpeed = "bestSpeed"
	// BestCompression copied from gzip.BestCompression
	BestCompression = "bestCompression"
	// DefaultCompression copied from gzip.DefaultCompression
	DefaultCompression = "defaultCompression"
	// HuffmanOnly copied from gzip.HuffmanOnly
	HuffmanOnly = "huffmanOnly"
)

Functions

func Middleware

func Middleware(opts ...Option) gin.HandlerFunc

Middleware Add gzip compress and decompress interceptors.

Mainly copied from bellow. https://github.com/labstack/echo/blob/master/middleware/decompress.go https://github.com/labstack/echo/blob/master/middleware/compress.go

Types

type Option

type Option func(*optionSet)

Option if for middleware options while creating middleware

func WithEntryNameAndType

func WithEntryNameAndType(entryName, entryType string) Option

WithEntryNameAndType provide entry name and entry type.

func WithLevel

func WithLevel(level string) Option

WithLevel provide level of compressing.

func WithPathToIgnore

func WithPathToIgnore(prefix ...string) Option

WithPathToIgnore provide path prefix to ignore middleware

func WithSkipper

func WithSkipper(skip Skipper) Option

WithSkipper provide skipper.

type Skipper

type Skipper func(*gin.Context) bool

Skipper default skipper will always return false