Cldr.DateTime.Formatter.zone_id

You're seeing just the function zone_id, go back to Cldr.DateTime.Formatter module for more information.

zone_id(zone_id, n \\ 1, options \\ [])

Specs

zone_id(Calendar.time(), integer(), Keyword.t()) ::
  String.t() | {:error, String.t()}

Returns the time zone ID (format symbol V) part of a DateTime or Time

For now the short timezone name, exemplar city and generic location formats are not supported and therefore return the fallbacks defined in CLDR.

Arguments

time is a Time struct or any map that contains at least the :utc_offset and :std_offset keys of the format used by Time
n is the specific non-location timezone format and is in the range 1..4
locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Cldr.get_locale/0
options is a Keyword list of options. There are no options used in zone_id/4

Format Symbol

The representation of the timezone ID is made in accordance with the following table:

Symbol	Results	Description
V	"unk"	`:zone_abbr` key, unlocalised
VV	"Etc/UTC	Delegates to `zone_gmt/4`
VVV	"Unknown City"	Examplar city. Not supported.
VVVV	"GMT"	Delegates to `zone_gmt/4

Examples

iex> Cldr.DateTime.Formatter.zone_id %{time_zone: "Etc/UTC",
...>   utc_offset: 0, std_offset: 0}, 1
"unk"

iex> Cldr.DateTime.Formatter.zone_id %{time_zone: "Etc/UTC",
...>   utc_offset: 0, std_offset: 0}, 2
"Etc/UTC"

iex> Cldr.DateTime.Formatter.zone_id %{time_zone: "Etc/UTC",
...>   utc_offset: 0, std_offset: 0}, 3
"Unknown City"

iex> Cldr.DateTime.Formatter.zone_id %{time_zone: "Etc/UTC",
...>   utc_offset: 0, std_offset: 0}, 4
"GMT"

zone_id(time, n, locale, backend, options \\ [])

Specs

zone_id(Calendar.time(), integer(), locale(), Cldr.backend(), Keyword.t()) ::
  String.t() | {:error, String.t()}