currency

Documentation

Overview

Package currency provides a data type for ISO 4217 currency code and list of world currencies from Unicode CLDR.

See https://www.iso.org/fr/iso-4217-currency-codes.html. See https://www.unicode.org/reports/tr35/tr35-numbers.html#Currencies. See common/supplemental/supplementalData.xml in CLDR data. See https://unicode.org/cldr/charts/33/supplemental/detailed_territory_currency_information.html

Index

• Constants
• Variables
• type Code
  • func (cc Code) IsValid() bool
  • func (cc Code) MarshalText() ([]byte, error)
  • func (cc *Code) Scan(src interface{}) error
  • func (cc *Code) Set(src string) error
  • func (cc Code) String() string
  • func (cc *Code) UnmarshalText(src []byte) error
  • func (cc Code) Value() (driver.Value, error)
• type FractionInfo
• type Info
• type Set
  • func Any() Set
  • func (cs *Set) Add(c Code)
  • func (cs Set) Contains(c Code) bool
  • func (cs Set) Copy() Set
  • func (cs *Set) Filter(filter Set)
  • func (cs Set) HasDuplicates() bool
  • func (cs Set) Len() int
  • func (cs Set) Less(i, j int) bool
  • func (cs Set) MarshalJSON() ([]byte, error)
  • func (cs Set) MarshalText() ([]byte, error)
  • func (cs Set) Matches(c Code) bool
  • func (cs Set) MatchesAny() bool
  • func (cs *Set) Remove(exclude Set)
  • func (cs *Set) RemoveDuplicates()
  • func (cs *Set) Scan(src interface{}) error
  • func (cs *Set) Set(src string) error
  • func (cs Set) String() string
  • func (cs Set) Swap(i, j int)
  • func (cs *Set) UnmarshalJSON(b []byte) error
  • func (cs *Set) UnmarshalText(b []byte) error
  • func (cs Set) Value() (driver.Value, error)

Constants

const (
	// Maximum cash fraction digits of any ActiveCurrencies
	MaxFractionCashDigits = 3
	// Maximum cash divisor of any ActiveCurrencies (10^MaxFractionCashDigits)
	MaxCashDivisor = 1000
)

Variables

var ActiveCurrencies = map[Code]*Info{}/* 153 elements not displayed */

ActiveCurrencies is the list of current legal tender currencies from Unicode CLDR.

Source: cldr-common-45.0.zip See https://unicode.org/cldr/charts/33/supplemental/detailed_territory_currency_information.html.

var ErrInvalidCurrencyCode = errors.New("invalid currency code")

var ErrInvalidSet = errors.New("invalid currencies set")

Types

type Code

type Code string

Code represents an ISO 4217 currency code: 3 ASCII letters, uppercase. See https://www.iso.org/fr/iso-4217-currency-codes.html.

func (Code) IsValid

func (cc Code) IsValid() bool

IsValid returns false if the code is invalid.

func (Code) MarshalText

func (cc Code) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*Code) Scan

func (cc *Code) Scan(src interface{}) error

Scan implements database/sql.Scanner.

func (*Code) Set

func (cc *Code) Set(src string) error

Set implements flag.Value.

func (Code) String

func (cc Code) String() string

String implements fmt.Stringer.

func (*Code) UnmarshalText

func (cc *Code) UnmarshalText(src []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (Code) Value

func (cc Code) Value() (driver.Value, error)

Value implements database/sql/driver.Valuer.

type FractionInfo

type FractionInfo struct {
	Digits       uint
	Rounding     uint
	CashDigits   uint
	CashRounding uint
}

type Info

type Info struct {
	Code Code

	Fraction FractionInfo

	Countries []string
}

type Set

type Set []Code

Set represents a set of currency codes. The zero value (nil) matches any currency.

The JSON representation (MarshalJSON) is an array of strings or null. The text representation (MarshalText) is codes separated by comma. The string representation (.String) is the text representation but with "*" if the set is empty.

func Any

func Any() Set

Any returns a Set where .MatchesAny() == true

func (*Set) Add

func (cs *Set) Add(c Code)

Add appends c if not already contained in the set.

func (Set) Contains

func (cs Set) Contains(c Code) bool

Contains returns true if cs contains c.

func (Set) Copy

func (cs Set) Copy() Set

Copy returns an independent copy.

func (*Set) Filter

func (cs *Set) Filter(filter Set)

Filter removes countries that are not Matched by filter.

The filter is assumed to not contain duplicates. An empty filter is a no-op (matches anything). Order is preserved.

func (Set) HasDuplicates

func (cs Set) HasDuplicates() bool

HasDuplicates checks if cs contains duplicates.

func (Set) Len

func (cs Set) Len() int

Len implements sort.Interface.

func (Set) Less

func (cs Set) Less(i, j int) bool

Less implements sort.Interface.

func (Set) MarshalJSON

func (cs Set) MarshalJSON() ([]byte, error)

MarshalJSON implements encoding/json.Marshaler.

func (Set) MarshalText

func (cs Set) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (Set) Matches

func (cs Set) Matches(c Code) bool

Matches returns true if the set is empty (matches anything) or contains c.

Same as Contains except for the empty set case which return true for any currency.

func (Set) MatchesAny

func (cs Set) MatchesAny() bool

MatchesAny returns true if the set is empty.

func (*Set) Remove

func (cs *Set) Remove(exclude Set)

Remove removes from cs the intersection of the two sets. If exclude is empty nothing is removed. Order is preserved.

func (*Set) RemoveDuplicates

func (cs *Set) RemoveDuplicates()

RemoveDuplicates remove duplicates. Order is preserved. In case of a duplicate the first one is kept.

func (*Set) Scan

func (cs *Set) Scan(src interface{}) error

func (*Set) Set

func (cs *Set) Set(src string) error

Set implements flag.Value.

func (Set) String

func (cs Set) String() string

String implements fmt.Stringer.

func (Set) Swap

func (cs Set) Swap(i, j int)

Swap implements sort.Interface.

func (*Set) UnmarshalJSON

func (cs *Set) UnmarshalJSON(b []byte) error

UnmarshalJSON implements encoding/json.Unmarshaler.

func (*Set) UnmarshalText

func (cs *Set) UnmarshalText(b []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (Set) Value

func (cs Set) Value() (driver.Value, error)

Value() implements database/sql/driver.Valuer.