bytefmt

Documentation

Index

• Constants
• func ToString(bytes ByteSize) string
• type ByteSize
  • func FromString(s string) (ByteSize, error)
  • func (t ByteSize) MarshalYAML() (interface{}, error)
  • func (f *ByteSize) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const (
	ByteUnit     = "b"
	KilobyteUnit = "kb"
	MegabyteUnit = "mb"
	GigabyteUnit = "gb"
	TerabyteUnit = "tb"
	PetabyteUnit = "pb"
	ExabyteUnit  = "eb"
)

const (
	Byte     = 1
	Kilobyte = 1024
	Megabyte = 1024 * 1024
	Gigabyte = 1024 * 1024 * 1024
	Terabyte = 1024 * 1024 * 1024 * 1024
	Petabyte = 1024 * 1024 * 1024 * 1024 * 1024
	Exabyte  = 1024 * 1024 * 1024 * 1024 * 1024 * 1024
)

Functions

func ToString

func ToString(bytes ByteSize) string

ByteSize returns a human-readable byte string of the form 10M, 12.5K, and so forth. The following units are available: The unit that results in the smallest number greater than or equal to 1 is always chosen.

Types

type ByteSize

type ByteSize int64

func FromString

func FromString(s string) (ByteSize, error)

ToBytes parses a string formatted by ByteSize as bytes. Note, this is based on the basis of 2 (no KiB, ...).

func (ByteSize) MarshalYAML

func (t ByteSize) MarshalYAML() (interface{}, error)

func (*ByteSize) UnmarshalYAML

func (f *ByteSize) UnmarshalYAML(unmarshal func(interface{}) error) error