ratelimiter

Documentation

Index

• Variables
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (lr *Reader) Read(p []byte) (n int, err error)
  • func (lr *Reader) ReadRateLimiter() *rate.Limiter
  • func (lr *Reader) SetReadRateLimiter(rLim *rate.Limiter)

Variables

var ErrReadLimitExcedeed = errors.New("ratelimiter: read limit exceeded")

ErrReadLimitExcedeed will be returned by Read method when current rate limit is exceeded.

Types

type Reader

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

Reader implements io.Reader interface.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a rate limited io.Read implementation.

func (*Reader) Read

func (lr *Reader) Read(p []byte) (n int, err error)

Read implements Reader interface method.

func (*Reader) ReadRateLimiter

func (lr *Reader) ReadRateLimiter() *rate.Limiter

ReadRateLimiter returns previously set rate limiter.

func (*Reader) SetReadRateLimiter

func (lr *Reader) SetReadRateLimiter(rLim *rate.Limiter)

SetReadRateLimiter sets current ReadWriter read rate limit.