ratelimit

package

v1.0.0 Latest Latest Go to latest Published: Nov 6, 2026 License: MIT Imports: 7 Imported by: 1

Details

Package ratelimit implements concurrency-safe in-memory token buckets.

This section is empty.

This section is empty.

func Middleware(l Limiter, key func(*http.Request) string) func(http.Handler) http.Handler

Middleware returns context-aware HTTP admission or coordination middleware.

type Config struct {
	Rate           float64
	Burst, MaxKeys int
	IdleTTL        time.Duration
	Now            func() time.Time
}

Config contains explicit constructor settings; see package documentation for defaults.

type Decision struct {
	Allowed    bool
	Remaining  int
	RetryAfter time.Duration
	Limit      int
}

Decision contains admission and retry-after metadata.

type Limiter interface {
	Allow(context.Context, string) (Decision, error)
}

Limiter evaluates a context-aware rate policy.

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

Memory provides bounded process-local coordination.

func New(c Config) (*Memory, error)

New constructs and validates an explicitly owned instance. See package documentation for defaults and cleanup.

func (m *Memory) Allow(ctx context.Context, key string) (Decision, error)

Allow evaluates the configured rate policy for a key.