View Source TzWorld.Backend behaviour (TzWorld v1.4.1)

Defines the callbacks for the TzWorld.Backend behaviour

Summary

Types

geo()

A point

lat()

Latitude in degrees

lng()

Longitude in degrees

Callbacks

all_timezones_at(t)

Returns all timezones at a specified point

reload_timezone_data()

Reloads the (potentially updated) timezone data

timezone_at(geo)

Returns the time zone at a specified point

Types

geo()

@type geo() :: Geo.Point.t()

A point

lat()

@type lat() :: -90..90

Latitude in degrees

lng()

@type lng() :: -180..180

Longitude in degrees

Callbacks

all_timezones_at(t)

@callback all_timezones_at(Geo.Point.t()) :: {:ok, [String.t()]} | {:error, atom()}

Returns all timezones at a specified point

reload_timezone_data()

@callback reload_timezone_data() :: {:ok, term()}

Reloads the (potentially updated) timezone data

timezone_at(geo)

@callback timezone_at(geo()) :: {:ok, String.t()} | {:error, atom()}

Returns the time zone at a specified point