NaturalTime (natural_time v0.1.0)
Link to this section Summary
Functions
Parses the given binary
as datetime.
Specify a string and a DateTime object indicating the reference time.
Link to this section Functions
Link to this function
datetime(binary, opts \\ [])
Specs
datetime(binary(), keyword()) :: {:ok, [term()], rest, context, line, byte_offset} | {:error, reason, rest, context, line, byte_offset} when line: {pos_integer(), byte_offset}, byte_offset: pos_integer(), rest: binary(), reason: String.t(), context: map()
Parses the given binary
as datetime.
Returns {:ok, [token], rest, context, position, byte_offset}
or
{:error, reason, rest, context, line, byte_offset}
where position
describes the location of the datetime (start position) as {line, column_on_line}
.
Options
:byte_offset
- the byte offset for the whole binary, defaults to 0:line
- the line and the byte offset into that line, defaults to{1, byte_offset}
:context
- the initial context value. It will be converted to a map
Link to this function
parse(str, rel \\ Timex.now())
Specs
parse(String.t(), DateTime.t()) :: nil | DateTime.t()
Specify a string and a DateTime object indicating the reference time.
The timezone information in the reference time will be used for inference. For example, if the reference time has timezone of "UTC+1", then "2pm" will parse to 2pm in UTC+1 timezone.
Example usage:
iex> now = Timex.parse!("2019-06-02T01:04:21+08:00", "{ISO:Extended}")
iex> parse("10pm", now) == Timex.parse!("2019-06-02T22:00:00+08:00", "{ISO:Extended}")
true