util

Documentation

Index

• Variables
• func DurationToHuman(d time.Duration) (str string)
• func FileExists(filename string) bool
• func RandomString(length int) string
• type Limiter
  • func NewLimiter(limit int64) *Limiter
  • func (l *Limiter) Add(n int64) error
  • func (l *Limiter) Limit() int64
  • func (l *Limiter) Set(n int64)
  • func (l *Limiter) Sub(n int64)
  • func (l *Limiter) Value() int64

Variables

var ErrLimitReached = errors.New("limit reached")

ErrLimitReached is the error returned by the Limiter and LimitWriter when the predefined limit has been reached

Functions

func DurationToHuman

func DurationToHuman(d time.Duration) (str string)

DurationToHuman converts a duration to a human readable format

func FileExists

func FileExists(filename string) bool

func RandomString

func RandomString(length int) string

RandomString returns a random string with a given length

Types

type Limiter

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

Limiter is a helper that allows adding values up to a well-defined limit. Once the limit is reached ErrLimitReached will be returned. Limiter may be used by multiple goroutines.

func NewLimiter

func NewLimiter(limit int64) *Limiter

NewLimiter creates a new Limiter

func (*Limiter) Add

func (l *Limiter) Add(n int64) error

Add adds n to the limiters internal value, but only if the limit has not been reached. If the limit would be exceeded after adding n, ErrLimitReached is returned.

func (*Limiter) Limit

func (l *Limiter) Limit() int64

Limit returns the defined limit

func (*Limiter) Set

func (l *Limiter) Set(n int64)

Set sets the value of the limiter to n. This function ignores the limit. It is meant to set the value based on reality.

func (*Limiter) Sub

func (l *Limiter) Sub(n int64)

Sub subtracts a value from the limiters internal value

func (*Limiter) Value

func (l *Limiter) Value() int64

Value returns the internal value of the limiter