bytesize

README

Byte size formatting and parsing.

todo: more robust tests

Documentation

Index

• Variables
• type Size
  • func ParseSize(s string) (Size, error)
  • func (sz Size) AppendFormat(dst []byte) []byte
  • func (sz Size) AppendFormatIEC(dst []byte) []byte
  • func (sz Size) AppendFormatSI(dst []byte) []byte
  • func (sz Size) String() string
  • func (sz Size) StringIEC() string
  • func (sz Size) StringSI() string

Variables

var (
	// ErrInvalidUnit is returned when an invalid IEC/SI is provided.
	ErrInvalidUnit = errors.New("bytesize: invalid unit")

	// ErrInvalidFormat is returned when an invalid size value is provided.
	ErrInvalidFormat = errors.New("bytesize: invalid format")
)

Types

type Size

type Size uint64

Size is a casting for uint64 types that provides formatting methods for byte sizes in both IEC and SI units.

func ParseSize

func ParseSize(s string) (Size, error)

ParseSize will parse a valid Size from given string. Both IEC and SI units are supported.

func (Size) AppendFormat

func (sz Size) AppendFormat(dst []byte) []byte

AppendFormat defaults to using Size.AppendFormatIEC().

func (Size) AppendFormatIEC

func (sz Size) AppendFormatIEC(dst []byte) []byte

AppendFormatIEC ...

func (Size) AppendFormatSI

func (sz Size) AppendFormatSI(dst []byte) []byte

AppendFormatSI ...

func (Size) String

func (sz Size) String() string

String returns a string format of Size, defaults to IEC unit format.

func (Size) StringIEC

func (sz Size) StringIEC() string

StringIEC returns an IEC unit string format of Size.

func (Size) StringSI

func (sz Size) StringSI() string

StringSI returns an SI unit string format of Size.