Drivers & Interfaces API Reference

Package distlimit defines storage contracts and driver constructors.

---

Driver Interface

The Driver interface abstracts key storage and evaluation persistence engines.

type Driver interface {
    Allow(ctx context.Context, key string, limit int64, window time.Duration, algo algorithm.Algorithm) (Result, error)
    Reset(ctx context.Context, key string) error
    Close(ctx context.Context) error
    Name() string
}

---

Memory Driver (driver/memory)

import "github.com/balramadan/distlimit/driver/memory"

New

Creates a 64-sharded in-memory storage driver with automatic background TTL key purge routines.

func New(cleanupInterval time.Duration) *Driver

---

Redis Driver (driver/redis)

import "github.com/balramadan/distlimit/driver/redis"

New

Creates a distributed Redis storage driver utilizing atomic Lua scripts and hash tags {}.

func New(client redis.UniversalClient) *Driver

---

Hybrid Driver (driver/hybrid)

import "github.com/balramadan/distlimit/driver/hybrid"

New

Creates a dual-tier resilient driver layering a Primary Redis Driver over an In-Memory Fallback Driver with Half-Open Circuit Breaker failover.

func New(primary distlimit.Driver, fallback distlimit.Driver, opts ...Option) *Driver

Options

• WithCoolOffDuration(duration): Sets duration to remain in fallback mode after Redis failure (Default: 5s).
• WithOnError(fn): Registers an error callback when Redis failover triggers.