timex v3.7.11

View Source Timex.Format.DateTime.Formatter behaviour (timex v3.7.11)

This module defines the behaviour for custom DateTime formatters.

Link to this section Summary

Callbacks

format!(date, format_string)
format(date, format_string)
lformat!( date, format_string, locale )
lformat( date, format_string, locale )
tokenize(format_string)

Functions

format!(date, format_string, formatter \\ Default)

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.

format(date, format_string, formatter \\ Default)

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.

format_token(token, date, modifiers, flags, width)

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.

format_token(locale, token, date, modifiers, flags, width)

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.

lformat!(date, format_string, locale, formatter \\ Default)

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.

lformat(date, format_string, locale, formatter \\ Default)

Formats a Date, DateTime, or NaiveDateTime as a string, using the provided format string, locale, and formatter.

validate(format_string, formatter \\ Default)

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

Link to this callback

format!(date, format_string)

View Source 
@callback format!(date :: Timex.Types.calendar_types(), format_string :: String.t()) ::
  String.t() | no_return()
Link to this callback

format(date, format_string)

View Source 
@callback format(date :: Timex.Types.calendar_types(), format_string :: String.t()) ::
  {:ok, String.t()} | {:error, term()}
Link to this callback

lformat!( date, format_string, locale )

View Source 
@callback lformat!(
  date :: Timex.Types.calendar_types(),
  format_string :: String.t(),
  locale :: String.t()
) :: String.t() | no_return()
Link to this callback

lformat( date, format_string, locale )

View Source 
@callback lformat(
  date :: Timex.Types.calendar_types(),
  format_string :: String.t(),
  locale :: String.t()
) :: {:ok, String.t()} | {:error, term()}
Link to this callback

tokenize(format_string)

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

Link to this section Functions

Link to this function

format!(date, format_string, formatter \\ Default)

View Source 
@spec format!(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.

Link to this function

format(date, format_string, formatter \\ Default)

View Source 
@spec format(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.

Link to this function

format_token(token, date, modifiers, flags, width)

View Source 
@spec 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.

Link to this function

format_token(locale, token, date, modifiers, flags, width)

View Source 
@spec format_token(
  String.t(),
  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.

Link to this function

lformat!(date, format_string, locale, formatter \\ Default)

View Source 
@spec lformat!(Timex.Types.valid_datetime(), String.t(), String.t(), atom() | nil) ::
  String.t() | no_return()

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

Link to this function

lformat(date, format_string, locale, formatter \\ Default)

View Source 
@spec lformat(Timex.Types.valid_datetime(), String.t(), String.t(), atom() | nil) ::
  {:ok, String.t()} | {:error, term()}

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

Link to this function

validate(format_string, formatter \\ Default)

View Source 
@spec 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.