Cldr Dates & Times v1.3.0 Cldr.Time View Source

Provides an API for the localization and formatting of a Time struct or any map with the keys :hour, :minute, :second and optionlly :microsecond.

CLDR provides standard format strings for Time 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

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

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

Link to this section Functions

Link to this function to_string(time, options \\ []) View Source

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

Returns either {:ok, formatted_time} or {:error, reason}.

  • time is a %DateTime{} or %NaiveDateTime{} struct or any map that contains the keys hour, minute, second and optionally calendar and microsecond

  • options is a keyword list of options for formatting. The valid options are:

    • format: :short | :medium | :long | :full or a format string. The default is :medium
    • locale: any locale returned by Cldr.known_locale_names(). The default is Cldr.get_current_locale()
    • 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” locale, for example, 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”

Examples

iex> Cldr.Time.to_string ~T[07:35:13.215217]
{:ok, "7:35:13 AM"}

iex> Cldr.Time.to_string ~T[07:35:13.215217], format: :short
{:ok, "7:35 AM"}

iex> Cldr.Time.to_string ~T[07:35:13.215217], format: :medium, locale: "fr"
{:ok, "07:35:13"}

iex> Cldr.Time.to_string ~T[07:35:13.215217], format: :medium
{:ok, "7:35:13 AM"}

iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Cldr.Time.to_string datetime, format: :long
{:ok, "11:59:59 PM UTC"}
Link to this function to_string!(time, options \\ []) View Source

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

Arguments

  • time is a %DateTime{} or %NaiveDateTime{} struct or any map that contains the keys hour, minute, second and optionally calendar and microsecond

  • options is a keyword list of options for formatting. The valid options are:

    • format: :short | :medium | :long | :full 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” locale, for example, 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 time string or

  • raises an exception.

Examples

iex> Cldr.Time.to_string! ~T[07:35:13.215217]
"7:35:13 AM"

iex> Cldr.Time.to_string! ~T[07:35:13.215217], format: :short
"7:35 AM"

iex> Cldr.Time.to_string ~T[07:35:13.215217], format: :short, period: :variant
{:ok, "7:35 am"}

iex> Cldr.Time.to_string! ~T[07:35:13.215217], format: :medium, locale: "fr"
"07:35:13"

iex> Cldr.Time.to_string! ~T[07:35:13.215217], format: :medium
"7:35:13 AM"

iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Cldr.Time.to_string! datetime, format: :long
"11:59:59 PM UTC"