Timex.Format.DateTime.Formatter behaviour
Summary↑
format!(date, format_string, formatter \\ Timex.Format.DateTime.Formatters.Default) | Formats a DateTime struct as a string, using the provided format string and formatter. If a formatter is not provided, the formatter used is |
format(date, format_string, formatter \\ Timex.Format.DateTime.Formatters.Default) | Formats a DateTime struct as a string, using the provided format string and formatter. If a formatter is not provided, the formatter used is |
format_token(token, date, modifiers, flags, min_width) | Given a token (as found in |
validate(format_string, formatter \\ Timex.Format.DateTime.Formatters.Default) | Validates the provided format string, using the provided formatter, or if none is provided, the default formatter. Returns |
Functions
Specs:
- format(%Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, String.t, Timex.Format.DateTime.Formatter | nil) :: {:ok, String.t} | {:error, term}
Formats a DateTime struct as a string, using the provided format string and formatter. If a formatter is not provided, the formatter used is Timex.DateFormat.Formatters.DefaultFormatter
.
Specs:
- format!(%Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, String.t, Timex.Format.DateTime.Formatter | nil) :: String.t | no_return
Formats a DateTime struct as a string, using the provided format string and formatter. If a formatter is not provided, the formatter used is Timex.DateFormat.Formatters.DefaultFormatter
.
If an error is encountered during formatting, format!
will raise.
Specs:
- format_token(atom, %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, [{:modifiers, [{atom, term}]}], [{:flags, [{atom, term}]}], integer) :: String.t
Given a token (as found in Timex.Parsers.Directive
), and a DateTime struct, produce a string representation of the token using values from the struct.
Specs:
- validate(String.t, Timex.Format.DateTime.Formatter | nil) :: :ok | {:error, term}
Validates the provided format string, using the provided formatter, or if none is provided, the default formatter. Returns :ok
when valid, or {:error, reason}
if not valid.
Callbacks
Specs:
- format(date :: %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, format_string :: String.t) :: {:ok, String.t} | {:error, term}
Specs:
- format!(date :: %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, format_string :: String.t) :: String.t | no_return
Specs:
- tokenize(format_string :: String.t) :: {:ok, [%Timex.Parse.DateTime.Tokenizers.Directive{flags: term, min_width: term, modifiers: term, parser: term, type: term, value: term}]} | {:error, term}