time_zone_info v0.3.0 TimeZoneInfo View Source

TimeZoneInfo provides a time zone database for Elixir using the data from the the Internet Assigned Numbers Authority (IANA).

Therefore TimeZoneInfo contains an implementation of the Calendar.TimeZoneDatabase behaviour under TimeZoneInfo.TimeZoneDatabase.

Link to this section Summary

Types

data()

The data structure containing all informations for TimeZoneInfo.

rule()

A rule representation.

The name of a rule set that can be found in the IANA data.

A reference to a rule set. The reference also contains utc_offset and format, The reference contains utc_offset and format because these values are needed to apply a rule.

time_standard()

The time standards used by IANA.

time_zone_period()

A period where a certain combination of UTC offset, standard offset and zone abbreviation is in effect.

A transition marks a point in time when one or more of the values utc-offset, std_offset or zone-abbr change.

The zone_state is either a timezone_period or a rules_ref.

Functions

Returns the version of the IANA database.

info()

Returns infos about persisted and stored data.

Returns the date time in UTC for the next update. Retruns :never if the automated update disabled.

state()

Returns the state of TimeZoneInfo.

time_zones(opts \\ [links: :include])

Returns the list of all available time zones with or without links. The option :links can be used to customize the list.

update(opt \\ :run)

Triggers the update process. Withe the opt :force the update will be forced.

Link to this section Types

data()

data() :: %{
  version: String.t(),
  time_zones: %{required(Calendar.time_zone()) => [transition()]},
  rules: %{required(rule_name()) => [rule()]},
  links: %{required(Calendar.time_zone()) => Calendar.time_zone()}
}

The data structure containing all informations for TimeZoneInfo.

rule()

rule() ::
  {{Calendar.month(), TimeZoneInfo.IanaParser.day(),
    {Calendar.hour(), Calendar.minute(), Calendar.second()}}, time_standard(),
   Calendar.std_offset(), TimeZoneInfo.Transformer.Abbr.letters()}

A rule representation.

rule_name()

rule_name() :: String.t()

The name of a rule set that can be found in the IANA data.

rules_ref()

rules_ref() ::
  {Calendar.utc_offset(), rule_name(), TimeZoneInfo.Transformer.Abbr.format()}

A reference to a rule set. The reference also contains utc_offset and format, The reference contains utc_offset and format because these values are needed to apply a rule.

time_standard()

time_standard() :: :wall | :standard | :gmt | :utc | :zulu

The time standards used by IANA.

time_zone_period()

time_zone_period() ::
  {Calendar.utc_offset(), Calendar.std_offset(), Calendar.zone_abbr()}

A period where a certain combination of UTC offset, standard offset and zone abbreviation is in effect.

This is equivalent to Calendar.TimeZoneDatabase.time_zone_period.t().

transition()

transition() ::
  {TimeZoneInfo.GregorianSeconds.t() | NaiveDateTime.t(), zone_state()}

A transition marks a point in time when one or more of the values utc-offset, std_offset or zone-abbr change.

zone_state()

zone_state() :: time_zone_period() | rules_ref()

The zone_state is either a timezone_period or a rules_ref.

Link to this section Functions

iana_version()

iana_version() :: String.t()

Returns the version of the IANA database.

info()

Returns infos about persisted and stored data.

next_update()

next_update() :: DateTime.t() | :never | :error

Returns the date time in UTC for the next update. Retruns :never if the automated update disabled.

state()

state() :: :ok | {:next, non_neg_integer()} | {:error, term()}

Returns the state of TimeZoneInfo.

Returns

:ok if everything runs normal and the automated update is disabled.
{:next, seconds} if everything runs normal.
{:error, reason} in case of an error.

time_zones(opts \\ [links: :include])

time_zones([{:links, :ignore | :only | :include}]) :: [Calendar.time_zone()]

Returns the list of all available time zones with or without links. The option :links can be used to customize the list.

Values for :links:

:ignore just the time zone names will be returned
:only just the link names will be returned
:include the time zone and link names will be returned (default)

The list will be sorted.

update(opt \\ :run)

update(opt :: :run | :force) ::
  :ok | {:next, non_neg_integer()} | {:error, term()}

Triggers the update process. Withe the opt :force the update will be forced.