limits

Documentation

Index

• type Limits
  • func NewLimits(maxAttempts int, retryAfter time.Duration, incrementFactor int, ...) *Limits
  • func (l *Limits) CleanRateLimit(username, categoryID string, provider string)
  • func (l *Limits) IsRateLimited(username, categoryID string, provider string) error
  • func (l *Limits) RecordFailedAttempt(username, categoryID string, provider string) error
• type RateLimitError
  • func (e *RateLimitError) Error() string

Types

type Limits

type Limits struct {
	// contains filtered or unexported fields
}

func NewLimits

func NewLimits(maxAttempts int, retryAfter time.Duration, incrementFactor int, maxTime time.Duration) *Limits

func (*Limits) CleanRateLimit

func (l *Limits) CleanRateLimit(username, categoryID string, provider string)

CleanRateLimit resets the rate limit count for a user

func (*Limits) IsRateLimited

func (l *Limits) IsRateLimited(username, categoryID string, provider string) error

IsRateLimited returns an error of type ErrRateLimited if the user is currently rate limited

func (*Limits) RecordFailedAttempt

func (l *Limits) RecordFailedAttempt(username, categoryID string, provider string) error

ReordFailedAttempt increases by 1 the failed attempts. If there's an active rate limit, it returns an ErrRateLimited error

type RateLimitError

type RateLimitError struct {
	RetryAfter time.Time
	// contains filtered or unexported fields
}

RateLimitError is an error that gets returned when the user has failed the login too much times

func (*RateLimitError) Error

func (e *RateLimitError) Error() string