ratelimit

package

v0.16.0 Latest Latest Go to latest Published: Oct 16, 2026 License: MIT Imports: 11 Imported by: 0

Details

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

Repository

github.com/AlexGalhardo/vukem

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ratelimit limits requests per key (token, user, IP) with GCRA, a smooth token bucket that needs one timestamp per key. The memory store fits one process; drivers/redis provides a shared one (BETA).

Index ¶

func ByIP(r *http.Request) string
func ByToken(r *http.Request) string
func Middleware(l Limiter, key KeyFunc) func(http.Handler) http.Handler
type KeyFunc
type Limiter
type Memory
- func NewMemory(limit int, window time.Duration) *Memory
- func (m *Memory) Allow(_ context.Context, key string) (Result, error)
type Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ByIP ¶

func ByIP(r *http.Request) string

ByIP keys requests by client IP (honouring trusted proxies).

func ByToken ¶

func ByToken(r *http.Request) string

ByToken keys requests by bearer token (hashed, never stored in clear), falling back to the client IP.

func Middleware ¶

func Middleware(l Limiter, key KeyFunc) func(http.Handler) http.Handler

Middleware limits requests with l, keyed by key (ByToken when nil). It sets RateLimit-Limit/Remaining/Reset on every response and answers 429 with Retry-After when the bucket is empty. A failing limiter denies the request (fail closed).

Types ¶

type KeyFunc ¶

type KeyFunc func(r *http.Request) string

KeyFunc picks the bucket for a request; "" skips limiting.

type Limiter ¶

type Limiter interface {
	Allow(ctx context.Context, key string) (Result, error)
}

Limiter decides whether a request for key may proceed.

type Memory ¶

type Memory struct {
	// contains filtered or unexported fields
}

Memory is an in-process GCRA limiter: limit requests per window, with bursts up to limit.

func NewMemory ¶

func NewMemory(limit int, window time.Duration) *Memory

NewMemory allows limit requests per window for each key.

func (*Memory) Allow ¶

func (m *Memory) Allow(_ context.Context, key string) (Result, error)

Allow implements Limiter.

type Result ¶

type Result struct {
	Allowed    bool
	Limit      int
	Remaining  int
	ResetAfter time.Duration // until the bucket is full again
	RetryAfter time.Duration // when denied: until the next request is allowed
}

Result is the outcome of one Allow call.

Source Files ¶

View all Source files

ratelimit.go

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