types

Documentation

Index

• Constants
• type Capacity
  • func NewCapacity(cap float64) (Capacity, error)
  • func (c Capacity) Equal(other Capacity) bool
  • func (c Capacity) MaxAvailable(totalUnits int64) int64
  • func (c Capacity) String() string
  • func (c Capacity) Value() float64
• type SentinelError
  • func (e SentinelError) Error() string

Constants

const ErrInvalidCapacity = SentinelError("capacity not within range [0,1]")

Types

type Capacity

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

func NewCapacity

func NewCapacity(cap float64) (Capacity, error)

func (Capacity) Equal

func (c Capacity) Equal(other Capacity) bool

func (Capacity) MaxAvailable

func (c Capacity) MaxAvailable(totalUnits int64) int64

func (Capacity) String

func (c Capacity) String() string

func (Capacity) Value

func (c Capacity) Value() float64

type SentinelError

type SentinelError string

SentinelError is type for defining constant error values.

Inspired by: https://dave.cheney.net/2019/06/10/constant-time

func (SentinelError) Error

func (e SentinelError) Error() string

Error returns the string value of a SentinelError.