unit

Documentation

Index

• Constants
• Variables
• type BinaryPrefix
  • func (b BinaryPrefix) Scale() float64
  • func (b BinaryPrefix) String() string
• type MetricPrefix
  • func ConvertToMetric(binaryPrefix BinaryPrefix) (MetricPrefix, float64, error)
  • func (m MetricPrefix) Scale() float64
  • func (m MetricPrefix) String() string
• type Prefix

Constants

const (
	MetricPrefixKilo MetricPrefix = "k"
	MetricPrefixMega              = "M"
	MetricPrefixGiga              = "G"
	MetricPrefixTera              = "T"
)

const (
	BinaryPrefixKibi BinaryPrefix = "Ki"
	BinaryPrefixMebi              = "Mi"
	BinaryPrefixGibi              = "Gi"
	BinaryPrefixTebi              = "Ti"
)

Variables

var BinaryPrefixes = []BinaryPrefix{BinaryPrefixKibi, BinaryPrefixMebi, BinaryPrefixGibi, BinaryPrefixTebi}

var MetricPrefixes = []MetricPrefix{MetricPrefixKilo, MetricPrefixMega, MetricPrefixGiga, MetricPrefixTera}

Types

type BinaryPrefix

type BinaryPrefix string

BinaryPrefix is a base 2 prefix for data storage.

func (BinaryPrefix) Scale

func (b BinaryPrefix) Scale() float64

Scale returns the scale from the base unit or -1 if invalid.

func (BinaryPrefix) String

func (b BinaryPrefix) String() string

type MetricPrefix

type MetricPrefix string

MetricPrefix is a base 10 prefix used by the metric system.

func ConvertToMetric

func ConvertToMetric(binaryPrefix BinaryPrefix) (MetricPrefix, float64, error)

ConvertToMetric returns the mapped metric prefix and a scale factor for adjusting values.

func (MetricPrefix) Scale

func (m MetricPrefix) Scale() float64

Scale returns the scale from the base unit or -1 if invalid.

func (MetricPrefix) String

func (m MetricPrefix) String() string

type Prefix

type Prefix interface {
	fmt.Stringer
	Scale() float64
}