Money v3.4.2 Money.ExchangeRates.Cache behaviour View Source

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

Link to this section Summary

Callbacks

Returns the exchange rates for a given date.

Initialize the cache when the exchange rates retriever is started

Retrieve the latest exchange rates from the cache.

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

Store the latest exchange rates in the cache.

Terminate the cache when the retriver process stops normally

Link to this section Functions

Link to this section Callbacks

Link to this callback

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

Returns the exchange rates for a given date.

Initialize the cache when the exchange rates retriever is started

Link to this callback

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

Retrieve the latest exchange rates from the cache.

Link to this callback

store_historic_rates(map, arg2) View Source
store_historic_rates(map(), Date.t()) :: :ok

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

Link to this callback

store_latest_rates(map, arg2) View Source
store_latest_rates(map(), DateTime.t()) :: :ok

Store the latest exchange rates in the cache.

Link to this callback

terminate() View Source
terminate() :: any()

Terminate the cache when the retriver process stops normally