gin

Documentation

Index

• func DefaultErrorHandler(c *gin.Context, err error)
• func DefaultKeyGetter(c *gin.Context) string
• func DefaultLimitReachedHandler(c *gin.Context)
• func NewMiddleware(limiter *limiter.Limiter, options ...Option) gin.HandlerFunc
• type ErrorHandler
• type KeyGetter
• type LimitReachedHandler
• type Middleware
  • func (middleware *Middleware) Handle(c *gin.Context)
• type Option
  • func WithErrorHandler(handler ErrorHandler) Option
  • func WithExcludedKey(handler func(string) bool) Option
  • func WithKeyGetter(handler KeyGetter) Option
  • func WithLimitReachedHandler(handler LimitReachedHandler) Option

Functions

func DefaultErrorHandler

func DefaultErrorHandler(c *gin.Context, err error)

DefaultErrorHandler is the default ErrorHandler used by a new Middleware.

func DefaultKeyGetter

func DefaultKeyGetter(c *gin.Context) string

DefaultKeyGetter is the default KeyGetter used by a new Middleware. It returns the Client IP address.

func DefaultLimitReachedHandler

func DefaultLimitReachedHandler(c *gin.Context)

DefaultLimitReachedHandler is the default LimitReachedHandler used by a new Middleware.

func NewMiddleware

func NewMiddleware(limiter *limiter.Limiter, options ...Option) gin.HandlerFunc

NewMiddleware return a new instance of a gin middleware.

Types

type ErrorHandler

type ErrorHandler func(c *gin.Context, err error)

ErrorHandler is an handler used to inform when an error has occurred.

type KeyGetter

type KeyGetter func(c *gin.Context) string

KeyGetter will define the rate limiter key given the gin Context.

type LimitReachedHandler

type LimitReachedHandler func(c *gin.Context)

LimitReachedHandler is an handler used to inform when the limit has exceeded.

type Middleware

type Middleware struct {
	Limiter        *limiter.Limiter
	OnError        ErrorHandler
	OnLimitReached LimitReachedHandler
	KeyGetter      KeyGetter
	ExcludedKey    func(string) bool
}

Middleware is the middleware for gin.

func (*Middleware) Handle

func (middleware *Middleware) Handle(c *gin.Context)

Handle gin request.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is used to define Middleware configuration.

func WithErrorHandler

func WithErrorHandler(handler ErrorHandler) Option

WithErrorHandler will configure the Middleware to use the given ErrorHandler.

func WithExcludedKey

func WithExcludedKey(handler func(string) bool) Option

WithExcludedKey will configure the Middleware to ignore key(s) using the given function.

func WithKeyGetter

func WithKeyGetter(handler KeyGetter) Option

WithKeyGetter will configure the Middleware to use the given KeyGetter.

func WithLimitReachedHandler

func WithLimitReachedHandler(handler LimitReachedHandler) Option

WithLimitReachedHandler will configure the Middleware to use the given LimitReachedHandler.