frate

Documentation

Overview

Package frate implements file-based rate limiting.

Index

• type Limiter
  • func (l *Limiter) Err() error
  • func (l *Limiter) Errs() []error
  • func (l *Limiter) Touch(name string, d time.Duration) bool
  • func (l *Limiter) Touched() []string

Types

type Limiter

type Limiter struct {
	Dir string // defaults to "."
	// contains filtered or unexported fields
}

Limiter is a file-based rate limiter. It is not safe for concurrent use.

func (*Limiter) Err

func (l *Limiter) Err() error

Err returns the last error encountered, if any.

func (*Limiter) Errs

func (l *Limiter) Errs() []error

Errs returns all errors encountered, if any.

func (*Limiter) Touch

func (l *Limiter) Touch(name string, d time.Duration) bool

Touch updates the last-accessed time of the named bucket if the time since the current access time is >= d. It returns true if the bucket was touched; false otherwise.

If an error occurs, it is recorded and returned by Err.

func (*Limiter) Touched

func (l *Limiter) Touched() []string

Touched returns the names of the buckets that have been touched successfully. The returned slice is not safe to modify, and is only valid until the next call Touch.