limiter

Documentation

Index

• type Limiter
• type Result

Types

type Limiter

type Limiter interface {
	// TryHit tries to hit the limiter.
	TryHit(ctx context.Context, key string) (Result, error)
}

Limiter defines the limiter interface.

type Result

type Result struct {
	Limit     int
	Remaining int
	Reset     int64
	Reached   bool
}

Result defines the limiter result struct.