Timex.Format.DateTime.Formatter behaviour (timex v3.7.13)

View Source

This module defines the behaviour for custom DateTime formatters.

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.

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.

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.

Callbacks

format(date, format_string)

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

format!(date, format_string)

@callback format!(date :: Timex.Types.calendar_types(), format_string :: String.t()) ::
  String.t() | no_return()

lformat(date, format_string, locale)

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

lformat!(date, format_string, locale)

@callback lformat!(
  date :: Timex.Types.calendar_types(),
  format_string :: String.t(),
  locale :: String.t()
) :: String.t() | no_return()

tokenize(format_string)

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

Functions

format(date, format_string, formatter \\ Default)

@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.

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

@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.

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

@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.

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

@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.

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

@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

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

@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

validate(format_string, formatter \\ Default)

@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.