Timex.Parse.DateTime.Tokenizer behaviour (timex v4.0.0)

Copy Markdown View Source

Defines the API for a custom tokenizer which can extend Timex's datetime parsing facilities.

Summary

Callbacks

apply(t, token, value)
tokenize(format_string)

Callbacks

apply(t, token, value)

@callback apply(DateTime.t(), token :: atom(), value :: term()) ::
  DateTime.t() | {:error, term()} | :unrecognized

tokenize(format_string)

@callback tokenize(format_string :: String.t()) ::
  {:ok, [Timex.Parse.DateTime.Tokenizers.Directive.t()]} | {:error, term()}