Specs

to_string(map(), Keyword.t()) ::
  {:ok, String.t()} | {:error, {module(), String.t()}}

Formats a DateTime according to a format string as defined in CLDR and described in TR35

Arguments

• datetime is a %DateTime{} or %NaiveDateTime{}struct or any map that contains the keys :year, :month, :day, :calendar. :hour, :minute and :second with optional :microsecond.

• options is a keyword list of options for formatting.

Options

• format: :short | :medium | :long | :full or a format string or any of the keys returned by Cldr.DateTime.available_format_names. The default is :medium

• locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Cldr.get_locale/0

• number_system: a number system into which the formatted date digits should be transliterated

• era: :variant will use a variant for the era is one is available in the locale. In the "en" for example, the locale era: :variant will return "BCE" instead of "BC".

• period: :variant will use a variant for the time period and flexible time period if one is available in the locale. For example, in the "en" locale period: :variant will return "pm" instead of "PM"

Returns

• {:ok, formatted_datetime} or

• {:error, reason}

Examples

iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> MyApp.Cldr.DateTime.to_string datetime
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> MyApp.Cldr.DateTime.to_string datetime, locale: "en"
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> MyApp.Cldr.DateTime.to_string datetime, format: :long, locale: "en"
{:ok, "January 1, 2000 at 11:59:59 PM UTC"}
iex> MyApp.Cldr.DateTime.to_string datetime, format: :hms, locale: "en"
{:ok, "11:59:59 PM"}
iex> MyApp.Cldr.DateTime.to_string datetime, format: :full, locale: "en"
{:ok, "Saturday, January 1, 2000 at 11:59:59 PM GMT"}
iex> MyApp.Cldr.DateTime.to_string datetime, format: :full, locale: "fr"
{:ok, "samedi 1 janvier 2000 à 23:59:59 UTC"}