Cldr Dates & Times

v2.2.3

Cldr Dates & Times

Cldr Dates & Times v2.2.3 Cldr.Time View Source

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

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

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

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

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

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

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, backend \\ Cldr.default_backend(), options \\ [])

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

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

Returns

  • {:ok, formatted_time} or

  • {:error, reason}.

Arguments

  • time is a %DateTime{} or %NaiveDateTime{} struct or any map that contains the keys hour, minute, second and optionally calendar and 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

  • format: :short | :medium | :long | :full or a format string. The default is :medium

  • locale: any locale returned by Cldr.known_locale_names/1. The default is Cldr.get_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], MyApp.Cldr
{:ok, "7:35:13 AM"}

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

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

iex> Cldr.Time.to_string ~T[07:35:13.215217], MyApp.Cldr, 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, MyApp.Cldr, format: :long
{:ok, "11:59:59 PM UTC"}
Link to this function

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

View Source 
to_string!(map(), module() | Keyword.t(), Keyword.t()) ::
  String.t() | no_return()

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

  • 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

  • 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_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], MyApp.Cldr
"7:35:13 AM"

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

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

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

iex> Cldr.Time.to_string! ~T[07:35:13.215217], MyApp.Cldr, 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, MyApp.Cldr, format: :long
"11:59:59 PM UTC"