TimeZoneInfo v0.5.0 TimeZoneInfo.Downloader behaviour View Source

The behaviour for downloaders.

Link to this section Summary

HTTP headers.

mode()

The mode to download the data.

opts()

HTTP status code

download() :: {:ok, mode(), {status_code(), binary()}}

headers() :: [{header_name :: String.t(), header_value :: String.t()}]

HTTP headers.

mode() :: :iana | :etf | :ws

The mode to download the data.

Possible modes:

:iana downloads the data as a zipped tar archive in IANA format.
:etf downloads the data as a compressed file in the TimeZoneInfo External Term Format.
:ws downloads the data from a web service. In this mode, the configuration is sent to the server. The returned data is transformed according to the config on the server and comes in the same format as in the mode :etf.

opts() :: [headers: headers(), mode: mode()]

status_code() :: non_neg_integer()

HTTP status code

download(uri :: URI.t(), opts :: opts()) :: download() | {:error, term()}