convert

Documentation

Index

• Constants
• Variables
• type ByteAny
  • func ParseBytes(value string) (ByteAny, error)
• type BytesIEC
  • func (b BytesIEC) Bytes() uint64
  • func (b BytesIEC) HumanReadable() string
  • func (b BytesIEC) String() string
• type BytesSI
  • func (b BytesSI) Bytes() uint64
  • func (b BytesSI) HumanReadable() string
  • func (b BytesSI) String() string

Examples

• ParseBytes

Constants

const ExponentialFold = 2

ExponentialFold defines the value to fold back to the previous exponent for better display of a small value.

const IECBase = 1024

IECBase is the exponential base for IEC units.

const SIBase = 1000

SIBase is the exponential base for SI units.

Variables

var ByteIECUnits = []string{"B", "KiB", "MiB", "GiB", "TiB", "PiB"}

ByteIECUnits lists known units we can convert to based on uint64.

See https://en.wikipedia.org/wiki/Byte#Unit_symbol

var ByteSIUnits = []string{"B", "KB", "MB", "GB", "TB", "PB"}

ByteSIUnits lists known units we can convert to based on uint64.

See https://en.wikipedia.org/wiki/Byte#Unit_symbol

Types

type ByteAny

type ByteAny interface {
	HumanReadable() string
	Bytes() uint64
	fmt.Stringer
}

func ParseBytes

func ParseBytes(value string) (ByteAny, error)

ParseBytes parses a strings and returns the proper ByteAny implementation based on the unit specified.

When a plain value or B unit is used, ByteIEC is returned.

Example

bSI, err := ParseBytes("100MB")
if err != nil {
	log.Fatal(err)
}

bIEC, err := ParseBytes("100MiB")
if err != nil {
	log.Fatal(err)
}

fmt.Println("SI units")
fmt.Println(bSI.Bytes())
fmt.Println(bSI)
fmt.Println(bSI.HumanReadable())

fmt.Println("IEC units")
fmt.Println(bIEC.Bytes())
fmt.Println(bIEC)
fmt.Println(bIEC.HumanReadable())

Output:

SI units
100000000
100MB
100MB
IEC units
104857600
100MiB
100MiB

type BytesIEC

type BytesIEC uint64

BytesIEC is the IEC (1024) unit implementation of byte conversion.

func (BytesIEC) Bytes

func (b BytesIEC) Bytes() uint64

Bytes returns the value as uint64.

func (BytesIEC) HumanReadable

func (b BytesIEC) HumanReadable() string

HumanReadable returns the biggest sensible unit for the byte value with 2 decimal precision.

When value is smaller than 2 render it with a lower scale.

func (BytesIEC) String

func (b BytesIEC) String() string

type BytesSI

type BytesSI uint64

BytesSI is the SI (1000) unit implementation of byte conversion.

func (BytesSI) Bytes

func (b BytesSI) Bytes() uint64

Bytes returns the value as uint64.

func (BytesSI) HumanReadable

func (b BytesSI) HumanReadable() string

HumanReadable returns the biggest sensible unit for the byte value with 2 decimal precision.

When value is smaller than 2 render it with a lower scale.

func (BytesSI) String

func (b BytesSI) String() string