meta/bytesize
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Go library functions to format and parse quantities of bytes in human-readable formats, in IEC or SI units.
12 commits 1 branch 5 tags 42 KiB
  • Go 100%
Find a file
mathew 73bdc016e6 Merge pull request 'Add B as recognized unit' (#1) from whitequark/bytesize:main into main 
Reviewed-on: #1
2026-04-09 21:09:52 +02:00
bytesize.go Add B as recognized unit. 2026-04-09 18:46:54 +00:00
bytesize_test.go Add B as recognized unit. 2026-04-09 18:46:54 +00:00
go.mod Add B as recognized unit. 2026-04-09 18:46:54 +00:00
LICENSE.txt Update license to fix repeated word, generalize lack of employer endorsement 2022-10-26 10:58:45 -05:00
README.md Move to codeberg 2023-11-11 18:27:45 -06:00

README.md

bytesize

Description

Provides a function to print quantities of bytes in human-readable formats, and to parse human-readable amounts of bytes into int64 (where possible) or float64.

When formatting, allows you to choose precision (number of decimals) and whether you would prefer IEC or SI units (binary or base 10).

Modeled on strconv and the FormatInt / FormatFloat functions:

bytesize.FormatBytes(value int, base int, precision int) string
bytesize.ParseBytes(value string) (int64, error)
bytesize.ParseBytesFloat(value string) (float64, error)

Examples:

bytesize.FormatBytes(1024, 2, 1) = "1.0KiB"
bytesize.FormatBytes(2000000, 10, 2) = "2.00MB"
bytesize.ParseBytes("6 GiB") = 6442450944

License

BSD-style, because this particular wheel really doesn't need reinventing.

Rationale

While "Effective Go" has sample code for a ByteSize type, it has a number of problems:

  1. It doesn't support variable precision, and always returns two decimals.
  2. It gets the units wrong, using SI prefixes for binary units.
  3. It doesn't let you choose between SI and IEC units.
  4. It requires that you cast your quantities to ByteSize type.

Also, it doesn't handle parsing.

Additional information