rateplan

README

Rate plan

The Go package rateplan provides the schedulable rate limit writer.

Documentation

Overview

Package rateplan provides the schedulable rate limit writer.

Index

• Variables
• type Clock
• type Limiter
  • func NewLimiter(w io.Writer, bucket *ratelimit.Bucket, span timespan.Span) *Limiter
• type RatePlan
  • func NewRatePlan(bytesPerSec int64, span timespan.Span) *RatePlan
  • func NewRatePlanClock(bytesPerSec int64, span timespan.Span, clock Clock) *RatePlan
  • func ParseRatePlan(s string) (*RatePlan, error)
  • func (rp *RatePlan) NewLimiter(w io.Writer) *Limiter
  • func (rp *RatePlan) String() string
• type RatePlans
  • func ParseRatePlans(s string) (RatePlans, error)
  • func (rps RatePlans) NewLimiters(w io.Writer) []*Limiter
• type Writer
  • func NewWriter(w io.Writer, plans RatePlans) *Writer
  • func NewWriterClock(w io.Writer, plans RatePlans, clock Clock) *Writer
  • func (w *Writer) Write(b []byte) (int, error)

Variables

var (
	ErrParseRatePlan = errors.New("can't convert a string into RatePlan")
)

Types

type Clock

type Clock interface {
	// Now returns the current time.
	Now() time.Time
	// Sleep sleeps for at least the given duration.
	Sleep(time.Duration)
}

Clock represents the passage of time in a way that can be faked out for tests.

type Limiter

type Limiter struct {
	io.Writer
	timespan.Span
}

func NewLimiter

func NewLimiter(w io.Writer, bucket *ratelimit.Bucket, span timespan.Span) *Limiter

type RatePlan

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

func NewRatePlan

func NewRatePlan(bytesPerSec int64, span timespan.Span) *RatePlan

func NewRatePlanClock

func NewRatePlanClock(bytesPerSec int64, span timespan.Span, clock Clock) *RatePlan

func ParseRatePlan

func ParseRatePlan(s string) (*RatePlan, error)

func (*RatePlan) NewLimiter

func (rp *RatePlan) NewLimiter(w io.Writer) *Limiter

func (*RatePlan) String

func (rp *RatePlan) String() string

type RatePlans

type RatePlans []*RatePlan

func ParseRatePlans

func ParseRatePlans(s string) (RatePlans, error)

func (RatePlans) NewLimiters

func (rps RatePlans) NewLimiters(w io.Writer) []*Limiter

type Writer

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

func NewWriter

func NewWriter(w io.Writer, plans RatePlans) *Writer

func NewWriterClock

func NewWriterClock(w io.Writer, plans RatePlans, clock Clock) *Writer

func (*Writer) Write

func (w *Writer) Write(b []byte) (int, error)