https://github.com/toolmanorg/numbers-stdsize
Parse / Display Human Readable Standard Sizes
https://github.com/toolmanorg/numbers-stdsize
golang golang-library human-readable si-units
Last synced: 3 months ago
JSON representation
Parse / Display Human Readable Standard Sizes
- Host: GitHub
- URL: https://github.com/toolmanorg/numbers-stdsize
- Owner: toolmanorg
- License: mit
- Created: 2018-06-11T16:52:40.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T15:33:06.000Z (over 2 years ago)
- Last Synced: 2025-08-15T09:21:56.481Z (10 months ago)
- Topics: golang, golang-library, human-readable, si-units
- Language: Go
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://godoc.org/toolman.org/numbers/stdsize) [](https://goreportcard.com/report/toolman.org/numbers/stdsize) [](https://travis-ci.org/toolmanorg/numbers-stdsize)
# stdsize
`import "toolman.org/numbers/stdsize"`
* [Overview](#pkg-overview)
* [Install](#pkg-install)
* [Index](#pkg-index)
## Overview
Package stdsize provides the integer type "Value" that may be created
or displayed using human-readable strings. For example, "2Ki" gets
parsed as 2048 while the numeric value of 5\*1000\*1000 (i.e. 5 million)
is displayed as "5M".
## Install
``` sh
go get toolman.org/numbers/stdsize
```
## Index
* [Variables](#pkg-variables)
* [type Value](#Value)
* [func Parse(s string) (Value, error)](#Parse)
* [func ParseBinary(s string) (Value, error)](#ParseBinary)
* [func (v Value) Format(f fmt.State, c rune)](#Value.Format)
#### Package files
[format.go](/src/toolman.org/numbers/stdsize/format.go) [parse.go](/src/toolman.org/numbers/stdsize/parse.go) [parts.go](/src/toolman.org/numbers/stdsize/parts.go) [units.go](/src/toolman.org/numbers/stdsize/units.go) [value.go](/src/toolman.org/numbers/stdsize/value.go)
## Variables
``` go
var (
// ErrBadModifier is returned by Parse and ParseBinary if the
// given size modifier is unrecognized.
ErrBadModifier = errors.New("invalid size modifier")
// ErrNotInteger is returned by Parse and ParseBinary if no
// size modifier is provided and the given numeric value is
// not an integer.
ErrNotInteger = errors.New("bare size values must be integers")
)
```
## type [Value](/src/target/value.go?s=1156:1172#L16)
``` go
type Value int64
```
Value is a standard size value as returned by Parse or ParseBinary. It also
provides a custom formatter for displaying human-readable values.
``` go
const (
Kilo Value = 1000 // 10^3
Mega Value = Kilo * Kilo // 10^6
Giga Value = Mega * Kilo // 10^9
Tera Value = Giga * Kilo // 10^12
Peta Value = Tera * Kilo // 10^15
)
```
Constants for common decimal (i.e. power of 10) values.
``` go
const (
Kibi Value = 1 << (10 * (iota + 1)) // 2^10
Mibi // 2^20
Gibi // 2^30
Tebi // 2^40
Pebi // 2^50
)
```
Constants for common binary (i.e. power of 2) values.
### func [Parse](/src/target/parse.go?s=1531:1566#L31)
``` go
func Parse(s string) (Value, error)
```
Parse converts the size designation s to an integer Value. A size
designation is specified as any (real) numeric value, either positive
or negative, followed by a size modifier.
The following modifiers are supported:
Decimal Binary
-------- --------
K: 10^3 Ki: 2^10
M: 10^6 Mi: 2^20
G: 10^9 Gi: 2^30
T: 10^12 Ti: 2^40
P: 10^15 Pi: 2^50
For example, "1K" is 1000, "1Ki" is 1024, and "2.5Ki" is 2048 + 512 or 2560.
If no size modifier is provided then the numeric value must be an integer,
otherwise Parse returns ErrNotInteger.
If the given size modifier is unrecognized, Parse returns ErrBadModifier.
If the numeric value is unparsable, then Parse returns an error of type
*strconv.NumError.
### func [ParseBinary](/src/target/parse.go?s=1745:1786#L37)
``` go
func ParseBinary(s string) (Value, error)
```
ParseBinary is similar to Parse except all size modifiers are assumed to be
binary. In other words, both "K" and "Ki" are interpreted as 2^10.
### func (Value) [Format](/src/target/format.go?s=907:949#L16)
``` go
func (v Value) Format(f fmt.State, c rune)
```
Format implements fmt.Formatter to provide custom, printf style formatting
for Values. It is not intended to be called directly.