u24

Documentation

Index

• Constants
• func IsExceedMaximumUint24Error(err error) bool
• func IsNegativeUint24Error(err error) bool
• func ReadUint24ToInt(p []byte) int
• func WriteUint24(w io.Writer, n int) error
• type Uint24
  • func MustNewUint24(n int) Uint24
  • func NewUint24(v int) (n Uint24, err error)
  • func NewUint24Bytes(bs []byte) Uint24
  • func (p Uint24) AsInt() int
  • func (p Uint24) Bytes() []byte
  • func (p Uint24) WriteTo(w io.Writer) (int64, error)

Constants

const MaxUint24 = 16777215

MaxUint24 is the max value of Uint24.

Functions

func IsExceedMaximumUint24Error

func IsExceedMaximumUint24Error(err error) bool

IsExceedMaximumUint24Error returns true if exceed maximum Uint24. (16777215)

func IsNegativeUint24Error

func IsNegativeUint24Error(err error) bool

IsNegativeUint24Error returns true if number is negative.

func ReadUint24ToInt

func ReadUint24ToInt(p []byte) int

ReadUint24ToInt reads bytes then decode to int.

func WriteUint24

func WriteUint24(w io.Writer, n int) error

WriteUint24 encode and write Uint24 to an io.Writer.

Types

type Uint24

type Uint24 [3]byte

Uint24 is 3 bytes unsigned integer.

func MustNewUint24

func MustNewUint24(n int) Uint24

MustNewUint24 returns a new uint24.

func NewUint24

func NewUint24(v int) (n Uint24, err error)

NewUint24 returns a new uint24.

func NewUint24Bytes

func NewUint24Bytes(bs []byte) Uint24

NewUint24Bytes returns a new uint24 from bytes.

func (Uint24) AsInt

func (p Uint24) AsInt() int

AsInt converts to int.

func (Uint24) Bytes

func (p Uint24) Bytes() []byte

Bytes returns bytes encoded.

func (Uint24) WriteTo

func (p Uint24) WriteTo(w io.Writer) (int64, error)

WriteTo encode and write bytes to a writer.