Cldr Dates & Times v1.2.0 Cldr.DateTime View Source

Provides an API for the 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. Use of other calendars may not produce the expected results.

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 may define the underlying format string as appropriate.

Link to this section Summary

Functions

to_string(date, options \\ [])

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

to_string!(date_time, options \\ [])

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

Link to this section Functions

to_string(date, options \\ [])

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

Options

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. The valid options are:
- 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_current_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> Cldr.DateTime.to_string datetime, locale: Cldr.Locale.new!("en")
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Cldr.DateTime.to_string datetime, format: :long, locale: Cldr.Locale.new!("en")
{:ok, "January 1, 2000 at 11:59:59 PM UTC"}
iex> Cldr.DateTime.to_string datetime, format: :full, locale: Cldr.Locale.new!("en")
{:ok, "Saturday, January 1, 2000 at 11:59:59 PM GMT"}
iex> Cldr.DateTime.to_string datetime, format: :full, locale: Cldr.Locale.new!("fr")
{:ok, "samedi 1 janvier 2000 à 23:59:59 UTC"}

to_string!(date_time, options \\ [])

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

Options

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. The valid options are:
- 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_current_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

formatted_datetime or
raises an exception

Examples

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