rate

Documentation

Index

• type Limiter
  • func NewLocalRateLimiter(limit rate.Limit) Limiter
  • func NewRedisRateLimiter(limiter *redis_rate.Limiter, limit *redis_rate.Limit) Limiter
• type LimiterCtor
• type NoLimiter
  • func (n *NoLimiter) Allow(key string) (bool, error)

Types

type Limiter

type Limiter interface {
	Allow(key string) (bool, error)
}

Limiter limits operations based on a provided key.

func NewLocalRateLimiter

func NewLocalRateLimiter(limit rate.Limit) Limiter

NewRedisRateLimiter returns an in memory limiter.

func NewRedisRateLimiter

func NewRedisRateLimiter(limiter *redis_rate.Limiter, limit *redis_rate.Limit) Limiter

NewRedisRateLimiter returns a redis backed limiter.

type LimiterCtor

type LimiterCtor func(rate int) Limiter

LimiterCtor allows the creation of a Limiter using a provided rate.

type NoLimiter

type NoLimiter struct {
}

NoLimiter never limits operations

func (*NoLimiter) Allow

func (n *NoLimiter) Allow(key string) (bool, error)

Allow implements limiter.Allow.