timex v3.6.2 Timex.Format.DateTime.Formatter behaviour View Source
This module defines the behaviour for custom DateTime formatters.
Link to this section 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.
Link to this section Functions
format(date, format_string, formatter \\ Default)
View Sourceformat(Timex.Types.valid_datetime(), String.t(), atom() | nil) :: {:ok, String.t()} | {:error, term()}
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.
format!(date, format_string, formatter \\ Default)
View Sourceformat!(Timex.Types.valid_datetime(), String.t(), atom() | nil) :: String.t() | no_return()
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.
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
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.
Link to this section Callbacks
format(date, format_string)
View Sourceformat(date :: Timex.Types.calendar_types(), format_string :: String.t()) :: {:ok, String.t()} | {:error, term()}
format!(date, format_string)
View Sourceformat!(date :: Timex.Types.calendar_types(), format_string :: String.t()) :: String.t() | no_return()
lformat(date, format_string, locale)
View Sourcelformat( date :: Timex.Types.calendar_types(), format_string :: String.t(), locale :: String.t() ) :: {:ok, String.t()} | {:error, term()}
lformat!(date, format_string, locale)
View Sourcelformat!( date :: Timex.Types.calendar_types(), format_string :: String.t(), locale :: String.t() ) :: String.t() | no_return()