ratelimit

package
v0.99.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 7, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

func Remaining added in v0.74.0 

func Remaining(limit int, used int64) int

Remaining is the non-negative budget left after used requests. used is int64 because the Redis backend reads it straight from a Lua reply; it is clamped before any narrowing so an out-of-range count cannot wrap.

Types

type Limit added in v0.74.0 

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 added in v0.74.0 

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
}

Source Files

View all Source files

Directories

Path Synopsis
Package memorylimiter is the in-memory sliding-window rate limiter over ratelimit.Limit buckets.
 Package memorylimiter is the in-memory sliding-window rate limiter over ratelimit.Limit buckets.
Package redislimiter is the Redis-backed sliding-window rate limiter over ratelimit.Limit buckets.
 Package redislimiter is the Redis-backed sliding-window rate limiter over ratelimit.Limit buckets.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.