ratelimit

type Bucket struct {
	// Next reset.
	Next time.Time
	// Current number of tokens, starts at limit.
	Tokens int
	// The limit given in the header without any modifications.
	BaseLimit int
	// Maximum amount of tokens, modified by the LimitUsageFactor.
	Limit int
	// Time interval in seconds.
	Interval         time.Duration
	IntervalOverhead time.Duration
	// contains filtered or unexported fields
}

type InternalRateLimitStore struct {
	Route map[string]*Limits
	// contains filtered or unexported fields
}

type Limit struct {
	Type       string
	Buckets    []*Bucket
	RetryAfter time.Duration
	// contains filtered or unexported fields
}

type Limits struct {
	App     *Limit
	Methods map[string]*Limit
}

type RateLimit struct {
	StoreType StoreType
	// Factor to be applied to any Limit. E.g. If set to 0.5, the limit will be reduced by 50%.
	LimitUsageFactor float64
	// Delay, in milliseconds, added to reset intervals.
	IntervalOverhead time.Duration
	Enabled          bool
	// contains filtered or unexported fields
}

type Store interface {
	// Reserves one request for the App and Method buckets in a route.
	//
	// If rate limited, will block until the next bucket reset.
	Reserve(ctx context.Context, logger zerolog.Logger, route string, methodID string, isRSO bool) error

	// Creates new buckets in a route with the limits provided in the response headers.
	Update(ctx context.Context, logger zerolog.Logger, route string, methodID string, headers http.Header, retryAfter time.Duration) error
}

type StoreType string