ratelimit

package

v0.2.2 Latest Latest Go to latest Published: May 25, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func Take(ctx context.Context, l Limiter)

Take is a helper function that calls the Take method on a Limiter. It is used to apply rate limiting to an operation.

type Limiter interface {
	Take(ctx context.Context) time.Duration
}

Limiter is an interface for rate limiting functionality. It defines a method for taking a rate-limited action.

func NewLocalLimiter(maximumRPS int, burstableRPS int) Limiter

NewLocalLimiter creates a new local rate limiter with specified maximum and burstable requests per second.

func NewRedisLimiter(redisClient *redis.Client, maxRPS int) Limiter

NewRedisLimiter creates a new Redis-based rate limiter.

type Local struct {
	*rate.Limiter // Embedded rate limiter from the rate package
}

Local represents a local rate limiter using the golang.org/x/time/rate package.

func (l Local) Take(ctx context.Context) time.Duration

Take attempts to allow an action under the rate limit and returns the duration taken.

type Redis struct {
	*redis_rate.Limiter     // Embedded Redis rate limiter
	MaxRPS              int // Maximum requests per second allowed
}

Redis represents a rate limiter using Redis.

func (r Redis) Take(ctx context.Context) time.Duration

Take attempts to allow a request under the rate limit and blocks until allowed.