middleware

Documentation

Overview

Package middleware provide router middleware

Index

• type Collection
  • func NewCollection(ms ...Middleware) Collection
  • func (c Collection) Compose(h Handler) Handler
  • func (c Collection) Merge(m Collection) Collection
  • func (c Collection) Sort() Collection
• type Handler
• type Middleware
  • func WithPriority(middleware Middleware, priority uint) Middleware
• type WrapperFunc
  • func (f WrapperFunc) Priority() (priority uint)
  • func (f WrapperFunc) Wrap(h Handler) Handler

Types

type Collection

type Collection []Middleware

Collection is a slice of handler wrappers functions

func NewCollection

func NewCollection(ms ...Middleware) Collection

NewCollection provides new middleware

func (Collection) Compose

func (c Collection) Compose(h Handler) Handler

Compose returns middleware composed to single WrapperFunc

func (Collection) Merge

func (c Collection) Merge(m Collection) Collection

Merge merges another middleware

func (Collection) Sort

func (c Collection) Sort() Collection

Sort sorts collection by priority

type Handler

type Handler interface{}

Handler represents wrapped function

type Middleware

type Middleware interface {
	// Wrap Handler with middleware
	Wrap(Handler) Handler
	// Priority provides a value for sorting Collection, lower values come first
	Priority() uint
}

Middleware wraps Handler

func WithPriority

func WithPriority(middleware Middleware, priority uint) Middleware

WithPriority provides new Middleware with priority

type WrapperFunc

type WrapperFunc func(Handler) Handler

WrapperFunc is an adapter to allow the use of handler wrapper functions as middleware functions.

func (WrapperFunc) Priority

func (f WrapperFunc) Priority() (priority uint)

Priority provides a value for sorting Collection, lower values come first

func (WrapperFunc) Wrap

func (f WrapperFunc) Wrap(h Handler) Handler

Wrap implements Wrapper interface