humansize

README

Human-readable Sizes

Yet another 1k -> 1024 library, to avoid external dependencies.

Documentation

Overview

Package humansize - Human-readable data sizes

Index

• type Size
  • func MustNew(s string) Size
  • func (s *Size) MarshalText() (text []byte, err error)
  • func (s Size) String() string
  • func (s *Size) UnmarshalText(text []byte) error

Types

type Size

type Size uint64

Size allows us to give users the option to use suffixes like g and K. It is also suitable for passing to flag.TextVar.

func MustNew

func MustNew(s string) Size

MustNew retruns a new Size into which is unmarshalled s. If Unmarshalling fails, MustNew panics.

func (*Size) MarshalText

func (s *Size) MarshalText() (text []byte, err error)

MarshalText implements encoding.TextMarshaler. It is just s.String with extra steps.

func (Size) String

func (s Size) String() string

String implements fmt.Stringer and is more or less the inverse of UnmarshalText.

func (*Size) UnmarshalText

func (s *Size) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler. A nil or empty slices unmarshals to 0.