View Source Timex.Timezone.Local (timex v3.7.9)

This module is responsible for determining the timezone configuration of the local machine. It determines this from a number of sources, depending on platform, but the order of precedence is as follows:

ALL:

  • TZ environment variable. Ignored if nil/empty

OSX:

  • /etc/localtime
  • systemsetup -gettimezone (if admin rights are present)

UNIX:

  • /etc/timezone
  • /etc/sysconfig/clock
  • /etc/conf.d/clock
  • /etc/localtime
  • /usr/local/etc/localtime

Windows:

  • SYSTEM registry for the currently configured TimeZoneInformation

Each location is tried, and if an error is encountered, the next is attempted, until either a successful lookup is performed, or we run out of locations to check.

Link to this section Summary

Functions

Looks up the local timezone configuration. Returns the name of a timezone in the Olson database.

Given a binary representing the data from a tzfile (not the source version), parses out the timezone for the current date/time in UTC.

Link to this section Types

@type gregorian_seconds() :: non_neg_integer()

Link to this section Functions

@spec lookup() :: String.t() | {:error, term()}

Looks up the local timezone configuration. Returns the name of a timezone in the Olson database.

If no reference time is provided (in gregorian seconds), the current time in UTC will be used. If one is provided, the reference time will be used to find the local timezone for that reference time, if it exists.

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

Given a binary representing the data from a tzfile (not the source version), parses out the timezone for the current date/time in UTC.