timex v3.1.3 Timex.Format.DateTime.Formatter behaviour
This module defines the behaviour for custom DateTime formatters.
Summary
Functions
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format
string and formatter. If a formatter is not provided, the formatter
used is Timex.Format.DateTime.Formatters.DefaultFormatter
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format
string and formatter. If a formatter is not provided, the formatter
used is Timex.Format.DateTime.Formatters.DefaultFormatter
Given a token (as found in Timex.Parsers.Directive
), and a Date, DateTime, or NaiveDateTime struct,
produce a string representation of the token using values from the struct, using the default locale
Given a token (as found in Timex.Parsers.Directive
), and a Date, DateTime, or NaiveDateTime struct,
produce a string representation of the token using values from the struct
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format string,
locale, and formatter. If the locale provided does not have translations, “en” is used by
default. If a formatter is not provided, the formatter used is Timex.Format.DateTime.Formatters.DefaultFormatter
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format string,
locale, and formatter. If the locale does not have translations, “en” will be used by
default. If a formatter is not provided, the formatter used is Timex.Format.DateTime.Formatters.DefaultFormatter
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
Functions
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format
string and formatter. If a formatter is not provided, the formatter
used is Timex.Format.DateTime.Formatters.DefaultFormatter
.
Formatting will use the configured default locale, “en” if no other default is given.
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format
string and formatter. If a formatter is not provided, the formatter
used is Timex.Format.DateTime.Formatters.DefaultFormatter
.
Formatting will use the configured default locale, “en” if no other default is given.
If an error is encountered during formatting, format!
will raise.
format_token(atom, Timex.Types.calendar_types, list, list, list) :: String.t | {:error, term}
Given a token (as found in Timex.Parsers.Directive
), and a Date, DateTime, or NaiveDateTime struct,
produce a string representation of the token using values from the struct, using the default locale.
Given a token (as found in Timex.Parsers.Directive
), and a Date, DateTime, or NaiveDateTime struct,
produce a string representation of the token using values from the struct.
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format string,
locale, and formatter. If the locale provided does not have translations, “en” is used by
default. If a formatter is not provided, the formatter used is Timex.Format.DateTime.Formatters.DefaultFormatter
Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format string,
locale, and formatter. If the locale does not have translations, “en” will be used by
default. If a formatter is not provided, the formatter used is Timex.Format.DateTime.Formatters.DefaultFormatter
If an error is encountered during formatting, lformat!
will raise
validate(String.t, atom | 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
tokenize(format_string :: String.t) :: {:ok, [Timex.Parse.DateTime.Tokenizers.Directive.t]} | {:error, term}