Money.ExchangeRates.Cache behaviour (Money v5.5.3) View Source

Defines a cache behaviour and default inplementation of a cache for exchange rates

Link to this section Summary

Functions

cache()

historic_rates(date)

Callbacks

historic_rates(arg1)

Returns the exchange rates for a given date.

init()

Initialize the cache when the exchange rates retriever is started

Retrieve the latest exchange rates from the cache.

store_historic_rates(map, arg2)

Store the historic exchange rates for a given date in the cache.

store_latest_rates(map, arg2)

Store the latest exchange rates in the cache.

Terminate the cache when the retriver process stops normally

Link to this section Functions

cache()

historic_rates(date)

latest_rates()

Link to this section Callbacks

historic_rates(arg1)

Specs

historic_rates(Date.t()) :: {:ok, map()} | {:error, {Exception.t(), String.t()}}

Returns the exchange rates for a given date.

init()

Specs

init() :: any()

Initialize the cache when the exchange rates retriever is started

latest_rates()

Specs

latest_rates() :: {:ok, map()} | {:error, {Exception.t(), String.t()}}

Retrieve the latest exchange rates from the cache.

store_historic_rates(map, arg2)

Specs

store_historic_rates(map(), Date.t()) :: :ok

Store the historic exchange rates for a given date in the cache.

store_latest_rates(map, arg2)

Specs

store_latest_rates(map(), DateTime.t()) :: :ok

Store the latest exchange rates in the cache.

terminate()

Specs

terminate() :: any()

Terminate the cache when the retriver process stops normally