timex v0.19.3 → Overview → Timex → Format → DateTime → Formatter

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 Timex.DateFormat.Formatters.DefaultFormatter
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 Timex.DateFormat.Formatters.DefaultFormatter
format_token(token, date, modifiers, flags, width)

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
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 :ok when valid, or {:error, reason} if not valid

Functions

format(date, format_string, formatter \\ Timex.Format.DateTime.Formatters.Default)
(function) # ↑

Specs:

  • format(%Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, String.t, atom | 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.

format!(date, format_string, formatter \\ Timex.Format.DateTime.Formatters.Default)
(function) # ↑

Specs:

  • format!(%Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, String.t, atom | 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.

format_token(token, date, modifiers, flags, width)
(function) # ↑

Specs:

  • format_token(atom, %Timex.DateTime{calendar: term, day: term, hour: term, minute: term, month: term, ms: term, second: term, timezone: term, year: term}, list, list, list) :: String.t | {:error, term}

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.

validate(format_string, formatter \\ Timex.Format.DateTime.Formatters.Default)
(function) # ↑

Specs:

  • 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

format/2
(callback) # ↑

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}
format!/2
(callback) # ↑

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
tokenize/1
(callback) # ↑

Specs:

  • tokenize(format_string :: String.t) :: {:ok, [%Timex.Parse.DateTime.Tokenizers.Directive{flags: term, modifiers: term, parser: term, type: term, value: term, weight: term, width: term}]} | {:error, term}