timex v2.2.1 Timex.Format.Time.Formatter behaviour

This module defines the behaviour for custom Time formatters

Summary

Functions

Formats a Time tuple/Erlang timestamp, as a string, using the provided formatter. If a formatter is not provided, the formatter used is Timex.Format.Time.Formatters.Default. As a handy shortcut, you can reference the other built-in formatter (Humanized) via the :humanized atom as shown below

Same as format/1, but takes a formatter name as an argument

Same as format/1, but takes a locale name as an argument, and translates the format string, if the locale has translations

Same as lformat/2, but takes a formatter as an argument

Functions

format(timestamp)

Specs

format(Types.timestamp) :: String.t | {:error, term}

Formats a Time tuple/Erlang timestamp, as a string, using the provided formatter. If a formatter is not provided, the formatter used is Timex.Format.Time.Formatters.Default. As a handy shortcut, you can reference the other built-in formatter (Humanized) via the :humanized atom as shown below.

Examples

iex> Elixir.Timex.Format.Time.Formatter.format({1435, 180354, 590264})
"P45Y6M5DT21H12M34.590264S"
format(timestamp, formatter)

Specs

format(Types.timestamp, atom) ::
  String.t |
  {:error, term}

Same as format/1, but takes a formatter name as an argument

Examples

iex> Elixir.Timex.Format.Time.Formatter.format({1435, 180354, 590264}, :humanized) “45 years, 6 months, 5 days, 21 hours, 12 minutes, 34 seconds, 590.264 milliseconds”

lformat(timestamp, locale)

Specs

lformat(Types.timestamp, String.t) ::
  String.t |
  {:error, term}

Same as format/1, but takes a locale name as an argument, and translates the format string, if the locale has translations.

lformat(timestamp, locale, formatter)

Specs

lformat(Types.timestamp, String.t, atom) ::
  String.t |
  {:error, term}

Same as lformat/2, but takes a formatter as an argument

Callbacks

format(timestamp)

Specs

format(timestamp :: Types.timestamp) ::
  String.t |
  {:error, term}
lformat(timestamp, locale)

Specs

lformat(timestamp :: Types.timestamp, locale :: String.t) ::
  String.t |
  {:error, term}