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

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

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

Callbacks

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

Returns the exchange rates for a given date.

@callback init() :: any()

Initialize the cache when the exchange rates retriever is started

@callback 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, t)

View Source
@callback 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, t)

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

Store the latest exchange rates in the cache.

@callback terminate() :: any()

Terminate the cache when the retriver process stops normally

Functions