currency

Documentation

Index

• Variables
• type MicroUnit
  • func MicroUnitFromDecimal(d decimal.Decimal) (MicroUnit, error)
  • func MicroUnitFromFloatString(s string) (MicroUnit, error)
  • func NewMicroUnit(v int64) MicroUnit
  • func (m MicroUnit) Decimal() decimal.Decimal
  • func (m MicroUnit) FloatString() string
  • func (m MicroUnit) MarshalCSV() (string, error)
  • func (m *MicroUnit) UnmarshalCSV(s string) (err error)
  • func (m MicroUnit) Value() int64
• type USD
  • func Cents(cents int) USD
  • func Dollars(dollars int) USD
  • func (usd USD) Add(b USD) USD
  • func (usd USD) Cents() int
  • func (usd USD) String() string

Variables

var (
	// Error wraps errors coming from this package.
	Error = errs.Class("currency")
)

Types

type MicroUnit

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

MicroUnit represents 1e-6 or one millionth of a unit of currency (e.g. one millionth of a dollar). It is used instead of a floating point type to prevent rounding errors.

var (

	// Zero is a MicroUnit representing 0.
	Zero MicroUnit
)

func MicroUnitFromDecimal

func MicroUnitFromDecimal(d decimal.Decimal) (MicroUnit, error)

MicroUnitFromDecimal returns a MicroUnit from a decimal value and returns an error if there is not enough precision.

func MicroUnitFromFloatString

func MicroUnitFromFloatString(s string) (MicroUnit, error)

MicroUnitFromFloatString parses the string from FloatString into a MicroUnit.

func NewMicroUnit

func NewMicroUnit(v int64) MicroUnit

NewMicroUnit returns a MicroUnit with v. Much like a time.Duration, a value of 1 means 1e-6 or one millionth of a unit of currency.

func (MicroUnit) Decimal

func (m MicroUnit) Decimal() decimal.Decimal

Decimal returns the a decimal form of the MicroUnit.

func (MicroUnit) FloatString

func (m MicroUnit) FloatString() string

FloatString returns a string fixed to 6 decimal places.

func (MicroUnit) MarshalCSV

func (m MicroUnit) MarshalCSV() (string, error)

MarshalCSV does the custom marshaling of MicroUnits.

func (*MicroUnit) UnmarshalCSV

func (m *MicroUnit) UnmarshalCSV(s string) (err error)

UnmarshalCSV reads the MicroUnit in CSV form.

func (MicroUnit) Value

func (m MicroUnit) Value() int64

Value returns the underlying MicroUnit value.

type USD

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

USD describes USD currency.

func Cents

func Cents(cents int) USD

Cents converts cents to USD amount.

func Dollars

func Dollars(dollars int) USD

Dollars converts dollars to USD amount.

func (USD) Add

func (usd USD) Add(b USD) USD

Add adds two usd values and returns the result.

func (USD) Cents

func (usd USD) Cents() int

Cents returns amount in cents.

func (USD) String

func (usd USD) String() string

String returns the value in dollars.