ratelimit

package

v0.100.0 Latest Latest Go to latest Published: Sep 15, 2026 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/open-rails/authkit

Links

Open Source Insights

Documentation ¶

Index ¶

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

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.

func ValidateLimits ¶ added in v0.100.0

func ValidateLimits(limits map[string]Limit) error

ValidateLimits rejects policies that the millisecond-based backends cannot enforce identically. Disabling a limiter is an explicit HTTP configuration.

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 between accepted requests. 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
memory 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.
redis 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.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL