Datix.Time (datix v0.1.1) View Source
A Time
parser using Calendar.strftime
format-string.
Link to this section Summary
Functions
Parses a time string according to the given format
.
Parses a date string according to the given format
, erroring out for
invalid arguments.
Link to this section Functions
Specs
parse(String.t(), String.t(), list()) :: {:ok, Time.t()} | {:error, :invalid_time} | {:error, :invalid_input} | {:error, {:parse_error, [expected: String.t(), got: String.t()]}} | {:error, {:conflict, [expected: term(), got: term(), modifier: String.t()]}} | {:error, {:invalid_string, [{:modifier, String.t()}]}} | {:error, {:invalid_integer, [{:modifier, String.t()}]}} | {:error, {:invalid_modifier, [{:modifier, String.t()}]}}
Parses a time string according to the given format
.
See the Calendar.strftime
documentation for how to specify a format-string.
Options
:calendar
- the calendar to build theTime
, defaults toCalendar.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> Datix.Time.parse("10 PM", "%I %p")
{:ok, ~T[22:00:00]}
Specs
Parses a date string according to the given format
, erroring out for
invalid arguments.