Money.ExchangeRates.Callback behaviour (Money v5.21.0)

View Source

Default exchange rates retrieval callback module.

When exchange rates are successfully retrieved, the function latest_rates_retrieved/2 or historic_rates_retrieved/2 is called to perform any desired serialization or proocessing.

Summary

Callbacks

Defines the behaviour to retrieve historic exchange rates from an external data source.

Defines the behaviour to retrieve the latest exchange rates from an external data source.

Functions

Callback function invoked when historic exchange rates are retrieved.

Callback function invoked when the latest exchange rates are retrieved.

Callbacks

historic_rates_retrieved(map, t)

@callback historic_rates_retrieved(%{}, Date.t()) :: :ok

Defines the behaviour to retrieve historic exchange rates from an external data source.

latest_rates_retrieved(map, t)

@callback latest_rates_retrieved(%{}, DateTime.t()) :: :ok

Defines the behaviour to retrieve the latest exchange rates from an external data source.

Functions

historic_rates_retrieved(rates, date)

@spec historic_rates_retrieved(%{}, Date.t()) :: :ok

Callback function invoked when historic exchange rates are retrieved.

latest_rates_retrieved(rates, retrieved_at)

@spec latest_rates_retrieved(%{}, DateTime.t()) :: :ok

Callback function invoked when the latest exchange rates are retrieved.