limiter

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func RegisterKey(name string, fn KeyFunc)
• func Take(ctx context.Context, store limiter.Store, key KeyFunc) (bool, string, error)
• type Config
• type KeyFunc
  • func New(cfg *Config) (limiter.Store, KeyFunc, error)

Variables

var (
	// ErrMissingKey for limiter.
	ErrMissingKey = errors.New("limiter: missing key")
)

var Module = fx.Options(
	fx.Provide(New),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled limiter.

func RegisterKey

func RegisterKey(name string, fn KeyFunc)

RegisterKey with name and fn. Last register wins.

func Take

func Take(ctx context.Context, store limiter.Store, key KeyFunc) (bool, string, error)

Take from the store, returns if successful, info and error.

Types

type Config

type Config struct {
	Kind     string `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	Interval string `yaml:"interval,omitempty" json:"interval,omitempty" toml:"interval,omitempty"`
	Tokens   uint64 `yaml:"tokens,omitempty" json:"tokens,omitempty" toml:"tokens,omitempty"`
}

Config for limiter.

type KeyFunc

type KeyFunc func(context.Context) meta.Valuer

KeyFunc for the limiter.

func New

func New(cfg *Config) (limiter.Store, KeyFunc, error)

New limiter.