Cldr.DateTime.to_string
to_string
, go back to Cldr.DateTime module for more information.
to_string(datetime, backend \\ Cldr.Date.default_backend(), options \\ [])
View SourceSpecs
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
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 includesuse Cldr
and therefore is aCldr
backend module. The default isCldr.default_backend/0
.options
is a keyword list of options for formatting.
Options
format:
:short
|:medium
|:long
|:full
or a format string or any of the keys returned byCldr.DateTime.available_format_names
. 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 transliteratedera: :variant
will use a variant for the era is one is available in the locale. In the "en" for example, the localeera: :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
{: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
{: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"}