format

Documentation

Overview

Package format provides convenience functions for formatting.

Index

• Variables
• func Duration(duration time.Duration) string
• func FormatBytes(bytes uint64) string
• func FormatMilli(value uint64) string
• func GetMiltiplier(value uint64) (uint, string)

Variables

var (
	TimeFormatSeconds    string = "02 Jan 2006 15:04:05 MST"
	TimeFormatSubseconds string = "02 Jan 2006 15:04:05.99 MST"
)

Functions

func Duration

func Duration(duration time.Duration) string

Duration is similar to the time.Duration.String method from the standard library but is more readable and shows only 3 digits of precision when duration is less than 1 minute.

func FormatBytes

func FormatBytes(bytes uint64) string

FormatBytes returns a string with the number of bytes specified converted into a human-friendly format with a binary multiplier (i.e. GiB).

func FormatMilli

func FormatMilli(value uint64) string

FormatMilli formats the value in thousants as a floating point number.

func GetMiltiplier

func GetMiltiplier(value uint64) (uint, string)

GetMiltiplier will return the preferred base-2 multiplier (i.e. Ki, Mi, Gi) and right shift number for the specified vlaue.