@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()
) ::
  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()}

Convert a date to the given timezone (either TimezoneInfo or a timezone name)

@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.Types.valid_datetime()) ::
  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 date and time is returned.

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. The provided date and time can either be an Erlang datetime tuple, or a DateTime struct.

@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.

If a string is provided which isn't recognized, it is returned untouched, only when get/2 is called will the timezone lookup fail.

@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