size

package

v1.93.0 Latest Latest Go to latest Published: Apr 14, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ARM-software/golang-utils

Links

Open Source Insights

Documentation ¶

Overview ¶

Package size define common size units

Index ¶

Constants
Variables
func FindUnit(unitStr string) (value float64, canonicalUnit string, err error)
func FormatSizeAsBinarySI(value float64, scale int) (string, error)
func FormatSizeAsDecimalSI(value float64, scale int) (string, error)
func ParseSize(s string) (value float64, err error)

Constants ¶

View Source

const (
	B = 1

	KB = multiplication.Kilo * B
	MB = multiplication.Mega * B
	GB = multiplication.Giga * B
	TB = multiplication.Tera * B
	PB = multiplication.Peta * B
	EB = multiplication.Exa * B
	ZB = multiplication.Zeta * B
	YB = multiplication.Yotta * B

	KiB = float64(1 << 10)
	MiB = float64(1 << 20)
	GiB = float64(1 << 30)
	TiB = float64(1 << 40)
	PiB = float64(1 << 50)
	EiB = float64(1 << 60)
	ZiB = float64(1 << 70)
	YiB = float64(1 << 80)
)

Variables ¶

View Source

var (
	DecimalSIUnits = map[string]float64{
		"B":  B,
		"KB": KB,
		"MB": MB,
		"GB": GB,
		"TB": TB,
		"PB": PB,
		"EB": EB,
		"ZB": ZB,
		"YB": YB,
	}
	BinarySIUnits = map[string]float64{
		"B":   B,
		"KiB": KiB,
		"MiB": MiB,
		"GiB": GiB,
		"TiB": TiB,
		"PiB": PiB,
		"EiB": EiB,
		"ZiB": ZiB,
		"YiB": YiB,
	}
)

Functions ¶

func FindUnit ¶ added in v1.93.0

func FindUnit(unitStr string) (value float64, canonicalUnit string, err error)

func FormatSizeAsBinarySI ¶ added in v1.93.0

func FormatSizeAsBinarySI(value float64, scale int) (string, error)

FormatSizeAsBinarySI formats a size into a binary SI string (https://en.wikipedia.org/wiki/Binary_prefix) scale corresponds to the number of decimal places. For no limits, set to a negative number

func FormatSizeAsDecimalSI ¶ added in v1.93.0

func FormatSizeAsDecimalSI(value float64, scale int) (string, error)

FormatSizeAsDecimalSI formats a size into a decimal SI string (https://en.wikipedia.org/wiki/Binary_prefix) scale corresponds to the number of decimal places. For no limits, set to a negative number

func ParseSize ¶ added in v1.93.0

func ParseSize(s string) (value float64, err error)

Types ¶

This section is empty.

Source Files ¶

View all Source files

units.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL