View Source Cldr.DateTime (Cldr Dates & Times v2.12.0)

Provides localization and formatting of a DateTime struct or any map with the keys :year, :month, :day, :calendar, :hour, :minute, :second and optionally :microsecond.

Cldr.DateTime provides support for the built-in calendar Calendar.ISO or any calendars defined with ex_cldr_calendars

CLDR provides standard format strings for DateTime which are reresented by the names :short, :medium, :long and :full. This allows for locale-independent formatting since each locale will define the underlying format string as appropriate.

Link to this section Summary

Functions

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

Formats a DateTime according to a format string as defined in CLDR and described in TR35 returning a formatted string or raising on error.

Link to this section Functions

Link to this function

to_string(datetime, backend \\ Cldr.Date.default_backend(), options \\ [])

View Source

Specs

to_string(map(), Cldr.backend() | Keyword.t(), 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

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.

  • backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0.

  • options is a keyword list of options for formatting.

options

Options

  • format: :short | :medium | :long | :full or a format string or any of the keys returned by Cldr.DateTime.Format.date_time_available_formats/0. 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

Returns

  • {:ok, formatted_datetime} or

  • {:error, reason}

examples

Examples

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

to_string!(datetime, backend \\ Cldr.Date.default_backend(), options \\ [])

View Source

Specs

to_string!(map(), Cldr.backend() | Keyword.t(), Keyword.t()) ::
  String.t() | no_return()

Formats a DateTime according to a format string as defined in CLDR and described in TR35 returning a formatted string or raising on error.

arguments

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.

  • backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0.

  • options is a keyword list of options for formatting.

options

Options

  • format: :short | :medium | :long | :full or a format string or any of the keys returned by Cldr.DateTime.available_format_names or a format string. 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

Returns

  • formatted_datetime or

  • raises an exception

examples

Examples

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