@spec parse(String.t(), String.t() | Datix.compiled(), list()) ::
  {:ok, Time.t()}
  | {:error,
     Datix.FormatStringError.t()
     | Datix.ValidationError.t()
     | Datix.ParseError.t()
     | Datix.OptionError.t()}

Parses a time string according to the given format.

See the Calendar.strftime/3 documentation for how to specify a format string.

Options

• :calendar - the calendar to build the Time, defaults to Calendar.ISO

• :preferred_time - a string for the preferred format to show times, it can't contain the %X format and defaults to "%H:%M:%S" if the option is not received

• :am_pm_names - a keyword list with the names of the period of the day, defaults to [am: "am", pm: "pm"].

Missing values will be set to minimum.

Examples

iex> Datix.Time.parse("11:12:55", "%X")
{:ok, ~T[11:12:55]}

iex> format = Datix.compile!("%X")
iex> Datix.Time.parse("11:12:55", format)
{:ok, ~T[11:12:55]}

iex> Datix.Time.parse("10 PM", "%I %p")
{:ok, ~T[22:00:00]}

@spec parse!(String.t(), String.t() | Datix.compiled(), list()) :: Time.t()

Parses a date string according to the given format, erroring out for invalid arguments.

Options

Accepts the same options as listed for parse/3.