currency

Documentation

Overview

types and functions for converting currencies to/from enumeration values

Index

• type Currency
  • func FromUint64(n uint64) (Currency, error)
  • func (currency Currency) GetFee() (uint64, error)
  • func (currency Currency) GoString() string
  • func (currency Currency) MarshalText() ([]byte, error)
  • func (currency *Currency) Scan(state fmt.ScanState, verb rune) error
  • func (currency Currency) String() string
  • func (currency Currency) Uint64() uint64
  • func (currency *Currency) UnmarshalText(s []byte) error

Types

type Currency

type Currency uint64

currency enumeration

const (
	Nothing Currency = iota // this must be the first value
	Bitcoin Currency = iota

	First Currency = Nothing + 1
	Last  Currency = maximumValue - 1
)

possible currency values

func FromUint64

func FromUint64(n uint64) (Currency, error)

convert a number to a currency

func (Currency) GetFee

func (currency Currency) GetFee() (uint64, error)

convert a string to a currency

func (Currency) GoString

func (currency Currency) GoString() string

convert abot enum value and symbol, for debugging

func (Currency) MarshalText

func (currency Currency) MarshalText() ([]byte, error)

convert a currency into JSON

func (*Currency) Scan

func (currency *Currency) Scan(state fmt.ScanState, verb rune) error

convert a big endian hex representation to a digest for use by the format package scan routines

func (Currency) String

func (currency Currency) String() string

convert a currency to its string symbol

func (Currency) Uint64

func (currency Currency) Uint64() uint64

convert the currency to a number

func (*Currency) UnmarshalText

func (currency *Currency) UnmarshalText(s []byte) error

convert currency string to a currency enumeration value from JSON