soft_bank v0.1.3

SoftBank.Currency.Conversion.Rates (soft_bank v0.1.3) View Source

This is the CurrencyConversion.Rates struct.

Link to this section Summary

Types

t()

Functions

%SoftBank.Currency.Conversion.Rates{}

Defines a Currency DataSet

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %SoftBank.Currency.Conversion.Rates{
  base: atom(),
  rates: %{required(atom()) => float()}
}

Link to this section Functions

Link to this function

%SoftBank.Currency.Conversion.Rates{}

View Source (struct)

Defines a Currency DataSet

Values

  • base - Defines the base currency (all other currencies are derived from the base currency)
    • Type: atom
    • Example: :CHF
  • rates
    • Type: %{atom => float}
    • Example: %{CHF: 1.23, EUR: 1.132}

Examples 

iex> %CurrencyConversion.Rates{base: :EUR, rates: %{AUD: 1.4205, BGN: 1.9558}}
%CurrencyConversion.Rates{base: :EUR, rates: %{AUD: 1.4205, BGN: 1.9558}}