ratelimiter

package module

v0.2.0 Latest Latest Go to latest Published: Oct 29, 2025 License: MIT Imports: 2 Imported by: 1

Details

release

This package provides a basic rate limiter using a token bucket.

This project is licensed under the MIT License - see the LICENSE file for details.

This section is empty.

This section is empty.

This section is empty.

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

RateLimiter is a token bucket rate limiter.

func New(ctx context.Context, interval time.Duration, capacity int) *RateLimiter

New returns a new RateLimiter. Tokens are refilled at the given interval, up to the given capacity until the context is canceled.

func (rl *RateLimiter) Acquire(ctx context.Context) error

Acquire blocks until a token is available, or the context is canceled.

func (rl *RateLimiter) Release()

Release returns a token to the bucket.

func (rl *RateLimiter) TokenCount() int

TokenCount returns the number of tokens in the bucket.

func (rl *RateLimiter) TryAcquire() bool

TryAcquire returns true if a token is acquired, false otherwise.