limiter

Documentation

Index

• Variables
• func IsEnabled(c *Config) bool
• func New(cfg *Config) (*limiter.Limiter, error)
• type Config
• type KeyFunc

Variables

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

Module for fx.

var NoKey = func(context.Context) meta.Valuer {
	return meta.Blank
}

NoKey for the limiter.

Functions

func IsEnabled

func IsEnabled(c *Config) bool

IsEnabled limiter.

func New

func New(cfg *Config) (*limiter.Limiter, error)

New limiter.

Types

type Config

type Config struct {
	Enabled bool   `yaml:"enabled,omitempty" json:"enabled,omitempty" toml:"enabled,omitempty"`
	Kind    string `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	Pattern string `yaml:"pattern,omitempty" json:"pattern,omitempty" toml:"pattern,omitempty"`
}

Config for limiter.

type KeyFunc

type KeyFunc func(context.Context) meta.Valuer

KeyFunc for the limiter.