Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

types

package

Go to main page

Versions in this module

v1

v1.13.0

Jul 1, 2026

Changes in this version

type RateLimitProvider

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

+ type RateLimitValue struct

+ Count int

+ ExpiresAt time.Time

v1.12.0

Jun 20, 2026

v1.11.0

Jun 8, 2026

v1.10.0

Jun 8, 2026

v1.9.0

Jun 6, 2026

v1.8.0

Jun 5, 2026

v1.7.0

Jun 5, 2026

v1.6.0

May 18, 2026

Changes in this version

+ type DatabaseStorageConfig struct

+ CleanupInterval time.Duration

+ type MemoryStorageConfig struct

+ CleanupInterval time.Duration

+ type RateLimit struct

+ Count int

+ ExpiresAt time.Time

+ Key string

+ type RateLimitCheckRequest struct

+ ClientIP string

+ HTTPMethod string

+ Path string

+ type RateLimitCheckResponse struct

+ Allowed bool

+ Limit int

+ RetryAfter int

+ Window int

+ type RateLimitEntry struct

+ Count int

+ FirstReq time.Time

+ LastReset time.Time

+ type RateLimitPluginConfig struct

+ CustomRules map[string]RateLimitRule

+ Database *DatabaseStorageConfig

+ Enabled bool

+ Max int

+ Memory *MemoryStorageConfig

+ Prefix string

+ Provider RateLimitProviderType

+ Window time.Duration

+ func (config *RateLimitPluginConfig) ApplyDefaults()

+ type RateLimitProvider interface

+ CheckAndIncrement func(ctx context.Context, key string, window time.Duration, maxRequests int) (bool, int, time.Time, error)

+ Close func() error

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

+ GetName func() string

+ GetRule func(ctx context.Context, key string) (window time.Duration, maxRequests int, found bool, err error)

+ SetRule func(ctx context.Context, key string, window time.Duration, maxRequests int) error

+ type RateLimitProviderType string

+ const RateLimitProviderDatabase

+ const RateLimitProviderInMemory

+ const RateLimitProviderRedis

+ func (r RateLimitProviderType) String() string

+ type RateLimitRule struct

+ Disabled bool

+ Max int

+ Prefix string

+ Window time.Duration

+ type RateLimitRuleRecord struct

+ Key string

+ MaxRequests int

+ WindowSeconds int