ratelimit

Documentation

Index

• Constants
• func Remaining(limit, used int) int
• type Limit
  • func LookupLimit(limits map[string]Limit, bucket string) (Limit, bool)
• type Result

Constants

const (
	ReasonCooldown      = "cooldown"
	ReasonLimitExceeded = "limit_exceeded"
)

Functions

func Remaining

func Remaining(limit, used int) int

Remaining returns the non-negative requests left given a limit and used count.

Types

type Limit

type Limit struct {
	Limit    int
	Window   time.Duration
	Cooldown time.Duration
}

Limit configures a named rate-limit bucket: at most Limit requests per Window, with an optional Cooldown applied once the limit is hit. It is the single shared limit type consumed by the memory and redis limiter backends and the HTTP layer.

func LookupLimit

func LookupLimit(limits map[string]Limit, bucket string) (Limit, bool)

LookupLimit resolves the Limit for a bucket from a limits map: the bucket's own entry, else the "default" entry, else a conservative built-in fallback (found is false only for that fallback). Shared by the memory and redis backends.

type Result

type Result struct {
	Allowed    bool
	RetryAfter time.Duration
	Reason     string
	Limit      int
	Remaining  int
	Window     time.Duration
	Cooldown   time.Duration
}