RelativeDateTime (relative_datetime v0.2.0)

Parse a relative datetime string and return a datetime.

Summary

Functions

Parses a given relative datetime string and returns a datetime.

Parses the given binary as parse_relative_datetime.

Functions

Link to this function

parse(relative, datetime)

@spec parse(String.t(), DateTime.t()) :: {:ok, DateTime.t()} | :error

Parses a given relative datetime string and returns a datetime.

iex> RelativeDateTime.parse("3 days ago", ~U[2018-01-01 00:00:00Z])

Link to this function

parse_relative_datetime(binary, opts \\ [])

@spec parse_relative_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 parse_relative_datetime.

Returns {:ok, [token], rest, context, position, byte_offset} or {:error, reason, rest, context, line, byte_offset} where position describes the location of the parse_relative_datetime (start position) as {line, offset_to_start_of_line}.

To column where the error occurred can be inferred from byte_offset - offset_to_start_of_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