quantity

Documentation

Overview

Package quantity represents a quantity in the system.

Index

• type Quantity
  • func MustParse(value int) Quantity
  • func Parse(value int) (Quantity, error)
  • func (q Quantity) Equal(q2 Quantity) bool
  • func (q Quantity) MarshalText() ([]byte, error)
  • func (q Quantity) String() string
  • func (q Quantity) Value() int

Types

type Quantity

type Quantity struct {
	// contains filtered or unexported fields
}

Quantity represents a quantity in the system.

func MustParse

func MustParse(value int) Quantity

MustParse parses the string value and returns a quantity if the value complies with the rules for a quantity. If an error occurs the function panics.

func Parse

func Parse(value int) (Quantity, error)

Parse parses the float value and returns a quantity if the value complies with the rules for quantity.

func (Quantity) Equal

func (q Quantity) Equal(q2 Quantity) bool

Equal provides support for the go-cmp package and testing.

func (Quantity) MarshalText

func (q Quantity) MarshalText() ([]byte, error)

MarshalText provides support for logging and any marshal needs.

func (Quantity) String

func (q Quantity) String() string

String returns the value of the quantity.

func (Quantity) Value

func (q Quantity) Value() int

Value returns the int value of the quantity.