ratelimit

Documentation

Index

• Variables
• func NewDelayingLimiter[O interface{}](limit Waiter) endpoint.Middleware[O]
• func NewErroringLimiter[O interface{}](limit Allower) endpoint.Middleware[O]
• type Allower
• type AllowerFunc
  • func (f AllowerFunc) Allow() bool
• type Waiter
• type WaiterFunc
  • func (f WaiterFunc) Wait(ctx context.Context) error

Variables

var ErrLimited = errors.New("rate limit exceeded")

ErrLimited is returned in the request path when the rate limiter is triggered and the request is rejected.

Functions

func NewDelayingLimiter

func NewDelayingLimiter[O interface{}](limit Waiter) endpoint.Middleware[O]

NewDelayingLimiter returns an endpoint.Middleware that acts as a request throttler. Requests that would exceed the maximum request rate are delayed via the Waiter function

func NewErroringLimiter

func NewErroringLimiter[O interface{}](limit Allower) endpoint.Middleware[O]

NewErroringLimiter returns an endpoint.Middleware that acts as a rate limiter. Requests that would exceed the maximum request rate are simply rejected with an error.

Types

type Allower

type Allower interface {
	Allow() bool
}

Allower dictates whether or not a request is acceptable to run. The Limiter from "golang.org/x/time/rate" already implements this interface, one is able to use that in NewErroringLimiter without any modifications.

type AllowerFunc

type AllowerFunc func() bool

AllowerFunc is an adapter that lets a function operate as if it implements Allower

func (AllowerFunc) Allow

func (f AllowerFunc) Allow() bool

Allow makes the adapter implement Allower

type Waiter

type Waiter interface {
	Wait(ctx context.Context) error
}

Waiter dictates how long a request must be delayed. The Limiter from "golang.org/x/time/rate" already implements this interface, one is able to use that in NewDelayingLimiter without any modifications.

type WaiterFunc

type WaiterFunc func(ctx context.Context) error

WaiterFunc is an adapter that lets a function operate as if it implements Waiter

func (WaiterFunc) Wait

func (f WaiterFunc) Wait(ctx context.Context) error

Wait makes the adapter implement Waiter