distlimit

Jul 31, 2026

Changes in this version

type Limiter

+ func (l *Limiter) UpdatePolicy(limit int64, window time.Duration)

type Option

+ func WithMetricObserver(obs metrics.Observer) Option

+ func WithPolicyResolver(resolver PolicyResolver) Option

+ type Policy struct

+ Limit int64

+ Window time.Duration

+ type PolicyResolver interface

+ ResolvePolicy func(ctx context.Context, key string) (Policy, bool)

Jul 24, 2026

Changes in this version

type Driver

+ Reset func(ctx context.Context, key string) error

type Limiter

+ func (l *Limiter) ResetKey(ctx context.Context, key string) error

Jul 22, 2026

Changes in this version

+ var ErrNilAlgorithm = errors.New("distlimit: algorithm strategy cannot be nil")

+ type Config struct

type Option

+ func WithAlgorithm(alg algorithm.Algorithm) Option

+ type State = algorithm.State

Jul 21, 2026

Changes in this version

+ var ErrInvalidLimit = errors.New("Distlimit: The limit must be greater than 0")

+ var ErrInvalidWindow = errors.New("Distlimit: The window must be greater than 0")

+ var ErrNilDriver = errors.New("Distlimit: The driver must not be nil")

+ type Driver interface

+ Allow func(ctx context.Context, key string, limit int64, window time.Duration) (Result, error)

+ Close func(ctx context.Context) error

+ type KeyFunc func(ctx context.Context) string

+ type Limiter struct

+ func New(driver Driver, opts ...Option) (*Limiter, error)

+ func (l *Limiter) Allow(ctx context.Context) (Result, error)

+ func (l *Limiter) AllowKey(ctx context.Context, key string) (Result, error)

+ func (l *Limiter) Close(ctx context.Context) error

+ type Option func(*Limiter)

+ func WithKeyFunc(fn KeyFunc) Option

+ func WithLimit(limit int64) Option

+ func WithWindow(window time.Duration) Option

+ type Result struct

+ Allowed bool

+ Limit int64

+ Remaining int64

+ ResetIn time.Duration