View Source Mobilizon.Cldr.Time (Mobilizon v5.0.0-beta.1)
Summary
Functions
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 keyshour
,minute
,second
and optionallycalendar
andmicrosecond
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 byCldr.known_locale_names/1
. The default isCldr.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" localeperiod: :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"}
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 keyshour
,minute
,second
and optionallycalendar
andmicrosecond
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 byCldr.known_locale_names/0
or aCldr.LanguageTag
struct. The default isCldr.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" localeperiod: :variant
will return "pm" instead of "PM".
Returns
formatted_time_string
orraises an exception.
Examples
iex> Mobilizon.Cldr.Time.to_string! ~T[07:35:13.215217]
"7:35:13 AM"
iex> Mobilizon.Cldr.Time.to_string! ~T[07:35:13.215217], format: :short
"7:35 AM"
iex> Mobilizon.Cldr.Time.to_string ~T[07:35:13.215217], format: :short, period: :variant
{:ok, "7:35 AM"}
iex> Mobilizon.Cldr.Time.to_string! ~T[07:35:13.215217], format: :medium, locale: "fr"
"07:35:13"
iex> Mobilizon.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> Mobilizon.Cldr.Time.to_string! datetime, format: :long
"11:59:59 PM UTC"