ratelimit

package

v1.27.0 Latest Latest Go to latest Published: Oct 14, 2026 License: MIT Imports: 5 Imported by: 0

Details

Package ratelimit provides a per-IP token bucket rate limiter keyed by /32 for IPv4 and /64 for IPv6.

This section is empty.

This section is empty.

This section is empty.

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

func New(limit rate.Limit, burst int, opts ...Option) *Limiter

New creates a Limiter, panics on invalid arguments.

func (l *Limiter) Allow(addr net.Addr) bool

Allow reports whether a request from addr may proceed; non-IP addresses are always allowed.

type Option func(*options)

func WithAllow(prefixes ...netip.Prefix) Option

WithAllow exempts addresses within the given prefixes from limiting.

func WithMaxEntries(n int) Option

WithMaxEntries caps the number of tracked keys; new keys beyond it are not limited.