datasize

Documentation

Index

• Constants
• type DataSize
  • func New(magnitude *big.Float, unit Unit) DataSize
  • func Parse(input string) (DataSize, error)
  • func (d DataSize) Add(o DataSize) DataSize
  • func (d DataSize) Gte(o DataSize) bool
  • func (d DataSize) String() string
  • func (d DataSize) Sub(o DataSize) DataSize
  • func (d DataSize) ToBytes() DataSize
  • func (d DataSize) ToHumanReadable() DataSize
  • func (d DataSize) ToHumanReadableSi() DataSize
• type Unit
  • func UnitFromString(input string, assumeSi bool) (Unit, error)
  • func (u Unit) Base() int
  • func (u Unit) IsSi() bool
  • func (u Unit) Next() (Unit, bool)
  • func (u Unit) Previous() (Unit, bool)
  • func (u Unit) ShortString() string
  • func (u Unit) String() string
  • func (u Unit) ToSi() Unit
  • func (u Unit) ToStd() Unit

Constants

const (
	Invalid Unit = iota
	Byte
	Kilobyte
	Megabyte
	Gigabyte
	Terabyte
	Petabyte
	Exabyte

	Kibibyte = iota + gap - Exabyte + 1
	Mebibyte
	Gibibyte
	Tebibyte
	Pebibyte
	Exbibyte
)

Types

type DataSize

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

func New

func New(magnitude *big.Float, unit Unit) DataSize

func Parse

func Parse(input string) (DataSize, error)

Parse always parses using big and `RoundingMode.ToNearestAway`.

func (DataSize) Add

func (d DataSize) Add(o DataSize) DataSize

Add sums two numbers together, converting to the highest unit with a magnitude above 1. The result will be in the unit system (SI or std) of d.

func (DataSize) Gte

func (d DataSize) Gte(o DataSize) bool

func (DataSize) String

func (d DataSize) String() string

func (DataSize) Sub

func (d DataSize) Sub(o DataSize) DataSize

func (DataSize) ToBytes

func (d DataSize) ToBytes() DataSize

func (DataSize) ToHumanReadable

func (d DataSize) ToHumanReadable() DataSize

func (DataSize) ToHumanReadableSi

func (d DataSize) ToHumanReadableSi() DataSize

type Unit

type Unit int

func UnitFromString

func UnitFromString(input string, assumeSi bool) (Unit, error)

func (Unit) Base

func (u Unit) Base() int

func (Unit) IsSi

func (u Unit) IsSi() bool

IsSi reports if the Unit is an SI unit (Système international).

func (Unit) Next

func (u Unit) Next() (Unit, bool)

func (Unit) Previous

func (u Unit) Previous() (Unit, bool)

func (Unit) ShortString

func (u Unit) ShortString() string

func (Unit) String

func (u Unit) String() string

func (Unit) ToSi

func (u Unit) ToSi() Unit

ToSi converts

func (Unit) ToStd

func (u Unit) ToStd() Unit