ratelimit

package
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 22, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RateLimitError

type RateLimitError struct {
	Remaining int
	ResetAt   time.Time
}

func (*RateLimitError) Error

func (e *RateLimitError) Error() string

type RateLimitInfo

type RateLimitInfo struct {
	Allowed   bool
	Remaining int
	ResetAt   time.Time
}

type TokenBucket

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

func NewTokenBucket

func NewTokenBucket(capacity int, refillInterval time.Duration) *TokenBucket

func (*TokenBucket) AddN

func (tb *TokenBucket) AddN(n int)

func (*TokenBucket) Allow

func (tb *TokenBucket) Allow() bool

func (*TokenBucket) AllowN

func (tb *TokenBucket) AllowN(n int) bool

func (*TokenBucket) AllowWithInfo

func (tb *TokenBucket) AllowWithInfo() RateLimitInfo

func (*TokenBucket) Check

func (tb *TokenBucket) Check() RateLimitInfo

func (*TokenBucket) Remaining

func (tb *TokenBucket) Remaining() int

func (*TokenBucket) ResetTime

func (tb *TokenBucket) ResetTime() time.Time

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL