quantity

Documentation

Index

• func FormatAmount(amount uint64, width int) string
• func FormatBPS(n, sec float64, width int) string
• func FormatDuration(dt float64) string

Examples

• FormatAmount (Long)
• FormatAmount (Short)
• FormatBPS
• FormatDuration

Functions

func FormatAmount

func FormatAmount(amount uint64, width int) string

Example (Long)

package main

import (
	"fmt"

	"github.com/snapcore/snapd/strutil/quantity"
)

func main() {
	for _, amount := range []uint64{
		3,
		13, 95,
		103, 995,
		1013, 9995,
		10009, 99995,
	} {
		fmt.Printf("- %5d: 3: %q  5: %q  7: %q\n",
			amount,
			quantity.FormatAmount(amount, 3),
			quantity.FormatAmount(amount, -1),
			quantity.FormatAmount(amount, 7),
		)
	}
}

Output:

-     3: 3: "  3"  5: "    3"  7: "     3 "
-    13: 3: " 13"  5: "   13"  7: "    13 "
-    95: 3: " 95"  5: "   95"  7: "    95 "
-   103: 3: "103"  5: "  103"  7: "   103 "
-   995: 3: "995"  5: "  995"  7: "   995 "
-  1013: 3: " 1k"  5: " 1013"  7: "  1013 "
-  9995: 3: "10k"  5: "10.0k"  7: " 9.995k"
- 10009: 3: "10k"  5: "10.0k"  7: "10.009k"
- 99995: 3: ".1M"  5: " 100k"  7: "100.00k"

Example (Short)

package main

import (
	"fmt"

	"github.com/snapcore/snapd/strutil/quantity"
)

func main() {
	fmt.Printf("%q\n", quantity.FormatAmount(12345, -1))
}

Output:

"12.3k"

func FormatBPS

func FormatBPS(n, sec float64, width int) string

Example

package main

import (
	"fmt"
	"time"

	"github.com/snapcore/snapd/strutil/quantity"
)

func main() {
	fmt.Printf("%q\n", quantity.FormatBPS(12345, (10*time.Millisecond).Seconds(), -1))
}

Output:

"1.23MB/s"

func FormatDuration

func FormatDuration(dt float64) string

dt is seconds (as in the output of time.Now().Seconds())

Example

package main

import (
	"fmt"
	"math"
	"time"

	"github.com/snapcore/snapd/strutil/quantity"
)

func main() {
	for _, dt := range []time.Duration{
		3 * time.Nanosecond,
		36 * time.Microsecond,
		430 * time.Millisecond,
		5155 * time.Millisecond,
		time.Minute + 2*time.Second,
		124 * time.Minute / 10,
		2*time.Hour + 29*time.Minute,
		10*time.Hour + 9*time.Minute,
		10*time.Hour + 30*time.Minute,
		11*time.Hour + 2*time.Minute,
		30 * time.Hour,
		345 * time.Hour,
		357 * time.Hour,
		4272 * time.Hour,
		51368 * time.Hour,
		math.MaxInt64 / 10,
		math.MaxInt64,
	} {
		fmt.Printf("%q\n", quantity.FormatDuration(dt.Seconds()))
	}
	fmt.Printf("%q\n", quantity.FormatDuration(float64(math.MaxUint64)*365*24*60*60))
	fmt.Printf("%q\n", quantity.FormatDuration(math.MaxFloat64))

}

Output:

"3.0ns"
" 36µs"
"430ms"
"5.16s"
"1m02s"
"12.4m"
"2h29m"
"10h9m"
"10.5h"
"11h2m"
"1d06h"
"14d9h"
"14.9d"
" 178d"
"5.86y"
"29.2y"
" 292y"
" 18Ey"
"ages!"