gzip

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, server *echo.Server) error
• type Gzip
  • func NewGzip() *Gzip
  • func NewGzipWithConfigPath(path string) (*Gzip, error)
  • func NewGzipWithOptions(options *Options) *Gzip
  • func (i *Gzip) Register(ctx context.Context, server *echo.Server) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, server *echo.Server) error

Register registers a new gzip plugin for echo server.

Types

type Gzip

type Gzip struct {
	// contains filtered or unexported fields
}

Gzip represents gzip plugin for echo server.

func NewGzip

func NewGzip() *Gzip

NewGzip returns a new gzip plugin with default options.

func NewGzipWithConfigPath

func NewGzipWithConfigPath(path string) (*Gzip, error)

NewGzipWithConfigPath returns a new gzip plugin with options from config path.

func NewGzipWithOptions

func NewGzipWithOptions(options *Options) *Gzip

NewGzipWithOptions returns a new gzip plugin with options.

func (*Gzip) Register

func (i *Gzip) Register(ctx context.Context, server *echo.Server) error

Register registers this gzip plugin for echo server.

type Options

type Options struct {
	Enabled bool
	Level   int
}

Options gzip plugin for echo server options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals options based a given key path.