timex

v1.0.2

Timex.Parse.DateTime.Parser

This is the base plugin behavior for all Timex date/time string parsers.

Summary

Functions

parse(date_string, format_string)

Parses a date/time string using the default parser

parse(date_string, format_string, tokenizer)

Parses a date/time string using the provided tokenizer. Tokenizers must implement the Timex.Parse.DateTime.Tokenizer behaviour

parse!(date_string, format_string, tokenizer \\ DefaultTokenizer)

Same as parse/2 and parse/3, but raises on error

Functions

parse(date_string, format_string)

Specs

parse(binary, binary) ::
  {:ok, %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}} |
  {:error, term}

Parses a date/time string using the default parser.

Examples

iex> use Timex
...> {:ok, dt} = Elixir.Timex.Parse.DateTime.Parser.parse("2014-07-29T00:20:41.196Z", "{ISO:Extended:Z}")
...> dt.year
2014
iex> dt.month
7
iex> dt.day
29
iex> dt.timezone.full_name
"UTC"
parse(date_string, format_string, tokenizer)

Specs

parse(binary, binary, atom) ::
  {:ok, %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}} |
  {:error, term}

Parses a date/time string using the provided tokenizer. Tokenizers must implement the Timex.Parse.DateTime.Tokenizer behaviour.

Examples

iex> use Timex
...> {:ok, dt} = Elixir.Timex.Parse.DateTime.Parser.parse("2014-07-29T00:30:41.196-02:00", "{ISO:Extended}", Timex.Parse.DateTime.Tokenizers.Default)
...> dt.year
2014
iex> dt.month
7
iex> dt.day
29
iex> dt.timezone.full_name
"Etc/GMT+2"
parse!(date_string, format_string, tokenizer \\ DefaultTokenizer)

Specs

parse!(String.t, String.t, atom | nil) ::
  %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term} |
  no_return

Same as parse/2 and parse/3, but raises on error.