TimeZoneInfo (TimeZoneInfo v0.7.9)

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.

Summary

Types

data()

The data structure containing all informations for TimeZoneInfo.

data_config()

The configuration for data generation.

gregorian_seconds()

Seconds since year 0 in the gregorian calendar.

rule()

A rule representation.

rule_name()

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

rules_ref()

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. The wall_period contains the start and end of the time zone period in wall time.

time_zones()
transition()

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

wall_period()

The wall time period represented in a tuple with two naive date times.

zone_state()

The zone_state is either a timezone_period or a rules_ref.

Functions

data(iana_data_archive, config \\ [])

Generates TimeZoneInfo.data from the given iana_data_archive.

iana_version()

Returns the version of the IANA database.

info()

Returns infos about persisted and stored data.

next_update()

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.

Types

data()

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

The data structure containing all informations for TimeZoneInfo.

data_config()

@type data_config() :: [
  files: [String.t()],
  time_zones: time_zones(),
  lookahead: non_neg_integer()
]

The configuration for data generation.

  • :files: The list of files from the IANA DB download.
  • :time_zones: The list of time zones that will be used. The atom :all indicates that all time zones from the IANA DB will be used.
  • :lookahead: Number of years for which data are precalculated.

See Config page for more information.

gregorian_seconds()

@type gregorian_seconds() :: integer()

Seconds since year 0 in the gregorian calendar.

rule()

@type 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()

@type rule_name() :: String.t()

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

rules_ref()

@type 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()

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

The time standards used by IANA.

time_zone_period()

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

A period where a certain combination of UTC offset, standard offset and zone abbreviation is in effect. The wall_period contains the start and end of the time zone period in wall time.

time_zones()

@type time_zones() :: :all | [Calendar.time_zone()]

transition()

@type transition() :: {gregorian_seconds() | 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.

wall_period()

@type wall_period() :: {NaiveDateTime.t(), NaiveDateTime.t()}

The wall time period represented in a tuple with two naive date times.

zone_state()

@type zone_state() :: time_zone_period() | rules_ref()

The zone_state is either a timezone_period or a rules_ref.

Functions

data(iana_data_archive, config \\ [])

@spec data(binary(), data_config()) ::
  {:ok, binary() | data(), String.t()} | {:error, term()}

Generates TimeZoneInfo.data from the given iana_data_archive.

iana_version()

@spec iana_version() :: String.t()

Returns the version of the IANA database.

info()

@spec info() :: map()

Returns infos about persisted and stored data.

next_update()

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

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

state()

@spec 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])

@spec 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)

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

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