bytefmt

README

bytefmt

Human readable byte formatter

Example:

  bytefmt.ByteSize(100.5*bytefmt.MEGABYTE) // returns "100.5M"
  bytefmt.ByteSize(uint64(1024)) // returns "1K"

For documentation, please see http://godoc.org/github.com/pivotal-golang/bytefmt

Documentation

Overview

bytefmt contains helper methods and constants for converting to and from a human readable byte format.

bytefmt.ByteSize(100.5*bytefmt.MEGABYE) // "100.5M"
bytefmt.ByteSize(uint64(1024)) // "1K"

Index

• Constants
• func ByteSize(bytes uint64) string
• func ToMegabytes(s string) (uint64, error)

Constants

const (
	BYTE     = 1.0
	KILOBYTE = 1024 * BYTE
	MEGABYTE = 1024 * KILOBYTE
	GIGABYTE = 1024 * MEGABYTE
	TERABYTE = 1024 * GIGABYTE
)

Functions

func ByteSize

func ByteSize(bytes uint64) string

ByteSize returns a human readable byte string, of the format 10M, 12.5K, etc. The following units are available:

T Terabyte
G Gigabyte
M Megabyte
K Kilobyte

the unit that would result in printing the smallest whole number is always chosen

func ToMegabytes

func ToMegabytes(s string) (uint64, error)

ToMegabyte parses a string formatted by ByteSize as megabytes