size

Documentation

Index

• type ByteSize
  • func FromInt64(x int64) (size ByteSize, err error)
  • func FromString(s string) (size ByteSize, err error)
  • func (z ByteSize) MarshalJSON() ([]byte, error)
  • func (z ByteSize) String() string
  • func (z *ByteSize) UnmarshalJSON(b []byte) (err error)
• type NegativeSizeError
  • func (e NegativeSizeError) Error() string

Types

type ByteSize

type ByteSize uint64

ByteSize represents a number of bytes. It can be unmarshalled from a JSON number or a JSON string such as "10k" or "16mb" or "32 PB".

func FromInt64

func FromInt64(x int64) (size ByteSize, err error)

FromInt64 converts an int64 to a ByteSize if it is non-negative.

func FromString

func FromString(s string) (size ByteSize, err error)

FromString converts a string like "10 mb" or "16k" to a ByteSize. See units.RAMInBytes for more details.

func (ByteSize) MarshalJSON

func (z ByteSize) MarshalJSON() ([]byte, error)

MarshalJSON encodes the ByteSize as a JSON string.

func (ByteSize) String

func (z ByteSize) String() string

func (*ByteSize) UnmarshalJSON

func (z *ByteSize) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON converts a JSON number or string to a ByteSize. If b is a JSON number, it must be a positive integer. If b is a JSON string, it must be parsable by units.RAMInBytes.

type NegativeSizeError

type NegativeSizeError struct {
	Size int64
}

NegativeSizeError is returned when parsing a negative size.

func (NegativeSizeError) Error

func (e NegativeSizeError) Error() string