ratelimit

Documentation

Index

• Variables
• func RateLimit(opts ...Option) gin.HandlerFunc
• type Limiter
• type Option
  • func WithErrorHandler(errorHandler func(ctx *gin.Context, err error)) Option
  • func WithLimiter(limiter Limiter) Option
• type Options

Variables

var ErrRateLimitExceed = errors.New("rate limit exceeded")

Functions

func RateLimit

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

RateLimit returns a new limiter handler with options

Types

type Limiter

type Limiter interface {
	Allow(ctx *gin.Context) (func(), error)
}

Limiter limits rate of requests for server

type Option

type Option func(options *Options)

func WithErrorHandler

func WithErrorHandler(errorHandler func(ctx *gin.Context, err error)) Option

func WithLimiter

func WithLimiter(limiter Limiter) Option

type Options

type Options struct {
	Limiter      Limiter
	ErrorHandler func(ctx *gin.Context, err error)
}