@spec beginning_of_day(DateTime.t()) :: DateTime.t()

Shifts the provided DateTime to the beginning of the day in it's timezone

@spec convert(
  date :: DateTime.t() | NaiveDateTime.t(),
  tz :: Timex.AmbiguousTimezoneInfo.t()
) ::
  DateTime.t() | Timex.AmbiguousDateTime.t() | {:error, term()}

@spec convert(
  date :: DateTime.t() | NaiveDateTime.t(),
  tz :: Timex.TimezoneInfo.t() | Timex.Types.valid_timezone()
) :: DateTime.t() | Timex.AmbiguousDateTime.t() | {:error, term()}

Converts a date to the given timezone, accepting a timezone name or TimezoneInfo.

A NaiveDateTime is interpreted as wall time in the destination zone. A gap in an IANA zone or an explicit POSIX rule returns an AmbiguousDateTime with type: :gap, whose before and after values bound the missing wall times. In an overlap, type: :ambiguous contains both valid interpretations in chronological order. Neither result chooses an interpretation for the caller. Names and TimezoneInfo values follow the same rules.

A DateTime identifies an instant, which is preserved when changing zones. Unknown timezone names return {:error, :time_zone_not_found}.

@spec end_of_day(DateTime.t()) :: DateTime.t()

Shifts the provided DateTime to the end of the day in it's timezone

@spec exists?(String.t()) :: boolean()

Determines if a given zone name exists

@spec get(Timex.Types.valid_timezone()) ::
  Timex.TimezoneInfo.t() | Timex.AmbiguousTimezoneInfo.t() | {:error, term()}

Gets timezone info for a given zone name and date. The date provided can either be an Erlang datetime tuple, or a DateTime struct, and if one is not provided, then the current instant is used. A DateTime is interpreted as an instant; values without a timezone are interpreted as wall time in the requested zone.

Same as get/2, but allows specifying whether to obtain the TimezoneInfo based on utc time or wall time manually (:utc or :wall respectively).

@spec local() ::
  Timex.TimezoneInfo.t() | Timex.AmbiguousTimezoneInfo.t() | {:error, term()}

Gets the local timezone configuration for the current date and time.

@spec local(Timex.Types.valid_datetime()) ::
  Timex.TimezoneInfo.t() | Timex.AmbiguousTimezoneInfo.t() | {:error, term()}

Gets the local timezone configuration for the provided date and time. A DateTime identifies an instant, including its UTC offset. An Erlang datetime tuple, NaiveDateTime, or other value without a timezone is interpreted as local wall time. Use get/3 with :local and an explicit basis to interpret an unzoned value as UTC instead.

@spec name_of(
  Timex.Types.valid_timezone()
  | Timex.TimezoneInfo.t()
  | Timex.AmbiguousTimezoneInfo.t()
) ::
  String.t() | {:error, :time_zone_not_found} | {:error, term()}

This function takes one of the varying timezone representations:

• atoms
• offset integers
• shortcut names (i.e. :utc, :local, "Z", "A")

and resolves the full name of the timezone if it's able.

Canonical IANA names retain their database definitions, including the reversed POSIX signs in Etc/GMT zones: Etc/GMT-4 means UTC+04:00 and Etc/GMT+4 means UTC-04:00. Numeric offsets, signed offset strings, GMT shorthands and synthetic Etc/UTC offsets use arithmetic signs instead (GMT+4 means UTC+04:00). Synthetic Etc/GMT aliases with one or two hour digits and optional :MM minutes normalize to Etc/UTC names with the equivalent offset; for example, Etc/GMT-09:30 becomes Etc/UTC+09:30.

An unrecognized name returns {:error, :time_zone_not_found}.

@spec resolve(String.t(), non_neg_integer(), :utc | :wall) ::
  Timex.TimezoneInfo.t() | Timex.AmbiguousTimezoneInfo.t() | {:error, term()}

Given a timezone name as a string, and a date/time in the form of the number of seconds since year zero, attempt to resolve a TimezoneInfo for that date/time. If the time is ambiguous, AmbiguousTimezoneInfo will be returned. If no result is found, an error will be returned.

If an invalid zone name is provided, an error will be returned