cur

Documentation

Index

• Constants
• Variables
• type Currency
  • func ParseCurrency(s string) Currency
  • func (c Currency) ISO4217() *ISO4217
  • func (c Currency) MinorUnits() MinorUnits
  • func (c Currency) String() string
  • func (c Currency) Validate() error
• type ISO4217
• type MinorUnits
  • func (m MinorUnits) String() string
  • func (m MinorUnits) Validate() error
  • func (m MinorUnits) Zero() string

Constants

const (
	CodeKZT = "KZT"
	CodeUSD = "USD"
	CodeRUB = "RUB"
	CodeEUR = "EUR"
)

Variables

var (
	ErrBadCurrency = errors.New("bad currency")
)

var (
	ErrBadMinorUnit = errors.New("bad currency minor unit")
)

Types

type Currency

type Currency uint32

Currency is a currency type

const (
	// Unknown currency
	Unknown Currency = iota
	// KZT - Kazakhstan Tenge
	KZT
	// USD - U.S. Dollar
	USD
	// RUB - Russian Ruble
	RUB
	// EUR - Euro
	EUR
)

func ParseCurrency

func ParseCurrency(s string) Currency

ParseCurrency returns Currency or Unknown.

func (Currency) ISO4217

func (c Currency) ISO4217() *ISO4217

ISO4217 returns currency ISO4217 standard info or nil

func (Currency) MinorUnits

func (c Currency) MinorUnits() MinorUnits

MinorUnits returns minor units of currency or MinorUnitsUnknown.

func (Currency) String

func (c Currency) String() string

String return code of currency

USD.String() // "USD"

func (Currency) Validate

func (c Currency) Validate() error

Validate validates currency. In case of invalid currency returns ErrBadCurrency.

type ISO4217

type ISO4217 struct {
	Name           string
	AlphabeticCode string
	NumericCode    uint16
	MinorUnits     MinorUnits
}

type MinorUnits

type MinorUnits uint8

MinorUnits is a type for currency's minor units

const (
	MinorUnitsUnknown MinorUnits = 255
	MinorUnits0       MinorUnits = 0
	MinorUnits2       MinorUnits = 2
	MinorUnits3       MinorUnits = 3
)

func (MinorUnits) String

func (m MinorUnits) String() string

String returns string value of minor units

func (MinorUnits) Validate

func (m MinorUnits) Validate() error

Validate validates minor unit, on error returns ErrBadMinorUnit.

func (MinorUnits) Zero

func (m MinorUnits) Zero() string

Zero returns zero value for minor unit.

Example: MinorUnits(2).Zero // "00"