Returns a list of all the locale names defined in the CLDR repository.

Note that not necessarily all of these locales are available since functions are only generated for configured locales which is most cases will be a subset of locales defined in CLDR.

See also: requested_locales/1 and known_locales/1

Returns a boolean indicating if the specified locale is available in CLDR.

The return value depends on whether the locale is defined in the CLDR repository. It does not necessarily mean the locale is configured for Cldr. See also Cldr.known_locale_name?/2.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

Examples

iex> Cldr.available_locale_name?("en-AU")
true

iex> Cldr.available_locale_name?("en-SA")
false

Returns the default backend module.

The default backend is configured in config.exs under the ex_cldr key as follows:

config :ex_cldr,
  default_backend: <backend_module>

If not configured, the CLDR default backend of Cldr.Backend.Default is returned.

Returns the default locale.

Example

iex> Cldr.default_locale
%Cldr.LanguageTag{
  canonical_locale_name: "en-Latn-001",
  cldr_locale_name: "en-001",
  language_subtags: [],
  extensions: %{},
  gettext_locale_name: nil,
  language: "en",
  locale: %{},
  private_use: [],
  rbnf_locale_name: "en",
  requested_locale_name: "en-001",
  script: "Latn",
  territory: "001",
  transform: %{},
  language_variant: nil
}

Returns the default locale for a given backend.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module

Example

iex> Cldr.default_locale(TestBackend.Cldr)
%Cldr.LanguageTag{
  canonical_locale_name: "en-Latn-001",
  cldr_locale_name: "en-001",
  language_subtags: [],
  extensions: %{},
  gettext_locale_name: "en",
  language: "en",
  locale: %{},
  private_use: [],
  rbnf_locale_name: "en",
  requested_locale_name: "en-001",
  script: "Latn",
  territory: "001",
  transform: %{},
  language_variant: nil
}

Returns the default territory when a locale does not specify one and none can be inferred.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module

Example

iex> Cldr.default_territory(TestBackend.Cldr)
:"001"

Returns a unicode string representing a flag for a territory.

Options

• territory is any valid territory code returned by Cldr.known_territories/0 or a Cldr.LanguageTag.t

Returns

• A string representing a flag or

• An empty string if the territory is valid but no unicode grapheme is defined. This is true for territories that are aggregate areas such as "the world" which is "001"

• {:error, {Cldr.UnknownTerritoryError, message}}

Examples

iex> Cldr.flag :AU
"🇦🇺"

iex> Cldr.flag :US
"🇺🇸"

iex> Cldr.flag "UN"
"🇺🇳"

iex> Cldr.flag :UK
{:error, {Cldr.UnknownTerritoryError, "The territory :UK is unknown"}}

Return the Cldr locale for the current process.

Note that the locale is set per-process. If the locale is not set for the given process then:

• Return the global default locale which is defined under the :ex_cldr key in config.exs

• Or the system-wide default locale which is %Cldr.LanguageTag{canonical_locale_name: "en-Latn-001", cldr_locale_name: "en-001", extensions: %{}, gettext_locale_name: nil, language: "en", language_subtags: [], language_variant: nil, locale: %{}, private_use: [], rbnf_locale_name: "en", requested_locale_name: "en-001", script: "Latn", territory: "001", transform: %{}}

Note that if there is no locale set for the current process then an error is not returned - a default locale will be returned per the rules above.

Example

iex> Cldr.put_locale(TestBackend.Cldr.Locale.new!("pl"))
iex> Cldr.get_locale()
%Cldr.LanguageTag{
   canonical_locale_name: "pl-Latn-PL",
   cldr_locale_name: "pl",
   extensions: %{},
   language: "pl",
   locale: %{},
   private_use: [],
   rbnf_locale_name: "pl",
   territory: "PL",
   requested_locale_name: "pl",
   script: "Latn",
   transform: %{},
   language_variant: nil
 }

Return the backend's locale for the current process.

Note that the locale is set per-process. If the locale is not set for the given process then:

• return the current processes default locale

• or if not set, return the default locale of the specified backend

• or if that is not set, return the global default locale which is defined under the :ex_cldr key in config.exs

• Or the system-wide default locale which is %Cldr.LanguageTag{canonical_locale_name: "en-Latn-001", cldr_locale_name: "en-001", extensions: %{}, gettext_locale_name: nil, language: "en", language_subtags: [], language_variant: nil, locale: %{}, private_use: [], rbnf_locale_name: "en", requested_locale_name: "en-001", script: "Latn", territory: "001", transform: %{}}

Note that if there is no locale set for the current process then an error is not returned - a default locale will be returned per the rules above.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module

Example

iex> Cldr.put_locale(TestBackend.Cldr, "pl")
iex> Cldr.get_locale(TestBackend.Cldr)
%Cldr.LanguageTag{
   canonical_locale_name: "pl-Latn-PL",
   cldr_locale_name: "pl",
   extensions: %{},
   language: "pl",
   locale: %{},
   private_use: [],
   rbnf_locale_name: "pl",
   territory: "PL",
   requested_locale_name: "pl",
   script: "Latn",
   transform: %{},
   language_variant: nil
 }

Returns a list of strings representing the calendars known to Cldr.

Example

iex> Cldr.known_calendars
[:buddhist, :chinese, :coptic, :dangi, :ethiopic, :ethiopic_amete_alem,
 :gregorian, :hebrew, :indian, :islamic, :islamic_civil, :islamic_rgsa,
 :islamic_tbla, :islamic_umalqura, :japanese, :persian, :roc]

Returns a list of strings representing the currencies known to Cldr.

Example

iex> Cldr.known_currencies
[:XBB, :XEU, :SKK, :AUD, :CZK, :ISJ, :BRC, :IDR, :UYP, :VEF, :UAH, :KMF, :NGN,
 :NAD, :LUC, :AWG, :BRZ, :AOK, :SHP, :DEM, :UGS, :ECS, :BRR, :HUF, :INR, :TPE,
 :GYD, :MCF, :USS, :ALK, :TJR, :BGO, :BUK, :DKK, :LSL, :AZM, :ZRN, :MKN, :GHC,
 :JMD, :NOK, :GWP, :CVE, :RUR, :BDT, :NIC, :LAK, :XFO, :KHR, :SRD, :ESB, :PGK,
 :YUD, :BRN, :MAD, :PYG, :QAR, :MOP, :BOB, :CHW, :PHP, :SDG, :SEK, :KZT, :SDP,
 :ZWD, :XTS, :SRG, :ANG, :CLF, :BOV, :XBA, :TMT, :TJS, :CUC, :SUR, :MAF, :BRL,
 :PLZ, :PAB, :AOA, :ZWR, :UGX, :PTE, :NPR, :BOL, :MRO, :MXN, :ATS, :ARP, :KWD,
 :CLE, :NLG, :TMM, :SAR, :PEN, :PKR, :RUB, :AMD, :MDL, :XRE, :AOR, :MZN, :ESA,
 :XOF, :CNX, :ILR, :KRW, :CDF, :VND, :DJF, :FKP, :BIF, :FJD, :MYR, :BBD, :GEK,
 :PES, :CNY, :GMD, :SGD, :MTP, :ZMW, :MWK, :BGN, :GEL, :TTD, :LVL, :XCD, :ARL,
 :EUR, :UYU, :ZAL, :CSD, :ECV, :GIP, :CLP, :KRH, :CYP, :TWD, :SBD, :SZL, :IRR,
 :LRD, :CRC, :XDR, :SYP, :YUM, :SIT, :DOP, :MVP, :BWP, :KPW, :GNS, :ZMK, :BZD,
 :TRY, :MLF, :KES, :MZE, :ALL, :JOD, :HTG, :TND, :ZAR, :LTT, :BGL, :XPD, :CSK,
 :SLL, :BMD, :BEF, :FIM, :ARA, :ZRZ, :CHF, :SOS, :KGS, :GWE, :LTL, :ITL, :DDM,
 :ERN, :BAM, :BRB, :ARS, :RHD, :STD, :RWF, :GQE, :HRD, :ILP, :YUR, :AON, :BYR,
 :RSD, :ZWL, :XBD, :XFU, :GBP, :VEB, :BTN, :UZS, :BGM, :BAD, :MMK, :XBC, :LUF,
 :BSD, :XUA, :GRD, :CHE, :JPY, :EGP, :XAG, :LYD, :XAU, :USD, :BND, :XPT, :BRE,
 :ROL, :PLN, :MZM, :FRF, :MGF, :LUL, :SSP, :DZD, :IEP, :SDD, :ADP, :AFN, :IQD,
 :GHS, :TOP, :LVR, :YUN, :MRU, :MKD, :GNF, :MXP, :THB, :CNH, :TZS, :XPF, :AED,
 :SVC, :RON, :BEC, :CUP, :USN, :LBP, :BOP, :BHD, :UYW, :BAN, :MDC, :VUV, :MGA,
 :ISK, :COP, :BYN, :UAK, :TRL, :SCR, :KRO, :ILS, :ETB, :CAD, :AZN, :VNN, :NIO,
 :COU, :EEK, :KYD, :MNT, :HNL, :WST, :PEI, :YER, :MTL, :STN, :AFA, :ARM, :HKD,
 :NZD, :VES, :UYI, :MXV, :GTQ, :BYB, :XXX, :XSU, :HRK, :OMR, :BEL, :MUR, :ESP,
 :YDD, :MVR, :LKR, :XAF]

Returns either the Gettext locale_name in Cldr format or false based upon whether the locale name is configured in GetText.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Examples

iex> Cldr.known_gettext_locale_name("en", TestBackend.Cldr)
"en"

iex> Cldr.known_gettext_locale_name("en-SA", TestBackend.Cldr)
false

Returns a boolean indicating if the specified locale name is configured and available in Gettext.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Examples

iex> Cldr.known_gettext_locale_name?("en", TestBackend.Cldr)
true

iex> Cldr.known_gettext_locale_name?("!!", TestBackend.Cldr)
false

Returns a list of GetText locale names but in CLDR format with underscore replaces by hyphen in order to facilitate comparisons with Cldr locale names.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Returns either the locale_name or false based upon whether the locale name is configured in Cldr.

This is helpful when building a list of or expressions to return the first known locale name from a list.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Examples

iex> Cldr.known_locale_name("en-AU", TestBackend.Cldr)
"en-AU"

iex> Cldr.known_locale_name("en-SA", TestBackend.Cldr)
false

Returns a boolean indicating if the specified locale name is configured and available in Cldr.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Examples

iex> Cldr.known_locale_name?("en", TestBackend.Cldr)
true

iex> Cldr.known_locale_name?("!!", TestBackend.Cldr)
false

Returns a list of the known locale names.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Known locales are those locales which are the subset of all CLDR locales that have been configured for use either directly in the config.exs file or in Gettext.

Returns a list of atoms representing the number systems types known to Cldr.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Example

iex> Cldr.known_number_system_types(TestBackend.Cldr)
[:default, :finance, :native, :traditional]

Returns a list of atoms representing the number systems known to Cldr.

Example

iex> Cldr.known_number_systems
[:adlm, :ahom, :arab, :arabext, :armn, :armnlow, :bali, :beng, :bhks, :brah,
 :cakm, :cham, :cyrl, :deva, :ethi, :fullwide, :geor, :gong, :gonm, :grek,
 :greklow, :gujr, :guru, :hanidays, :hanidec, :hans, :hansfin, :hant, :hantfin,
 :hebr, :hmng, :hmnp, :java, :jpan, :jpanfin, :jpanyear, :kali, :khmr, :knda, :lana, :lanatham,
 :laoo, :latn, :lepc, :limb, :mathbold, :mathdbl, :mathmono, :mathsanb,
 :mathsans, :mlym, :modi, :mong, :mroo, :mtei, :mymr, :mymrshan, :mymrtlng,
 :newa, :nkoo, :olck, :orya, :osma, :rohg, :roman, :romanlow, :saur, :shrd,
 :sind, :sinh, :sora, :sund, :takr, :talu, :taml, :tamldec, :telu, :thai, :tibt,
 :tirh, :vaii, :wara, :wcho]

Returns either the RBNF locale_name or false based upon whether the locale name is configured in Cldr and has RBNF rules defined.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Examples

iex> Cldr.known_rbnf_locale_name("en", TestBackend.Cldr)
"en"

iex> Cldr.known_rbnf_locale_name("en-SA", TestBackend.Cldr)
false

Returns a boolean indicating if the specified locale name is configured and available in Cldr and supports rules based number formats (RBNF).

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Examples

iex> Cldr.known_rbnf_locale_name?("en", TestBackend.Cldr)
true

iex> Cldr.known_rbnf_locale_name?("!!", TestBackend.Cldr)
false

Returns a list of locale names which have rules based number formats (RBNF).

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module

Returns a list of the territories known to Cldr.

The territories codes are defined in UN M.49 which defines both individual territories and enclosing territories. These enclosing territories are defined for statistical purposes and do not relate to political alignment.

For example, the territory :"001" is defined as "the world".

Example

iex> Cldr.known_territories
[:"001", :"002", :"003", :"005", :"009", :"011", :"013", :"014", :"015", :"017",
 :"018", :"019", :"021", :"029", :"030", :"034", :"035", :"039", :"053", :"054",
 :"057", :"061", :"142", :"143", :"145", :"150", :"151", :"154", :"155", :"202",
 :"419", :AC, :AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :AQ, :AR, :AS, :AT, :AU,
 :AW, :AX, :AZ, :BA, :BB, :BD, :BE, :BF, :BG, :BH, :BI, :BJ, :BL, :BM, :BN, :BO,
 :BQ, :BR, :BS, :BT, :BV, :BW, :BY, :BZ, :CA, :CC, :CD, :CF, :CG, :CH, :CI, :CK,
 :CL, :CM, :CN, :CO, :CP, :CR, :CU, :CV, :CW, :CX, :CY, :CZ, :DE, :DG, :DJ, :DK,
 :DM, :DO, :DZ, :EA, :EC, :EE, :EG, :EH, :ER, :ES, :ET, :EU, :EZ, :FI, :FJ, :FK,
 :FM, :FO, :FR, :GA, :GB, :GD, :GE, :GF, :GG, :GH, :GI, :GL, :GM, :GN, :GP, :GQ,
 :GR, :GS, :GT, :GU, :GW, :GY, :HK, :HM, :HN, :HR, :HT, :HU, :IC, :ID, :IE, :IL,
 :IM, :IN, :IO, :IQ, :IR, :IS, :IT, :JE, :JM, :JO, :JP, :KE, :KG, :KH, :KI, :KM,
 :KN, :KP, :KR, :KW, :KY, :KZ, :LA, :LB, :LC, :LI, :LK, :LR, :LS, :LT, :LU, :LV,
 :LY, :MA, :MC, :MD, :ME, :MF, :MG, :MH, :MK, :ML, :MM, :MN, :MO, :MP, :MQ, :MR,
 :MS, :MT, :MU, :MV, :MW, :MX, :MY, :MZ, :NA, :NC, :NE, :NF, :NG, :NI, :NL, :NO,
 :NP, :NR, :NU, :NZ, :OM, :PA, :PE, :PF, :PG, :PH, :PK, :PL, :PM, :PN, :PR, :PS,
 :PT, :PW, :PY, :QA, :QO, :RE, :RO, :RS, :RU, :RW, :SA, :SB, :SC, :SD, :SE, :SG,
 :SH, :SI, :SJ, :SK, :SL, :SM, :SN, :SO, :SR, :SS, :ST, :SV, :SX, :SY, :SZ, :TA,
 :TC, :TD, :TF, :TG, :TH, :TJ, :TK, :TL, :TM, :TN, :TO, :TR, :TT, :TV, :TW, :TZ,
 :UA, :UG, :UM, :UN, :US, :UY, :UZ, :VA, :VC, :VE, :VG, :VI, :VN, :VU, :WF, :WS,
 :XK, :YE, :YT, :ZA, :ZM, :ZW]

Set the current process's locale for all backends.

This is the preferred approach.

Arguments

• locale is a Cldr.LanguageTag struct returned by Cldr.Locale.new!/2

Note that the argument must be a Cldr.LanguageTag struct with a non-nil :cldr_locale_name.

Examples

iex> Cldr.put_locale(TestBackend.Cldr.Locale.new!("en"))
{:ok,
 %Cldr.LanguageTag{
   canonical_locale_name: "en-Latn-US",
   cldr_locale_name: "en",
   language_subtags: [],
   extensions: %{},
   gettext_locale_name: "en",
   language: "en",
   locale: %{},
   private_use: [],
   rbnf_locale_name: "en",
   requested_locale_name: "en",
   script: "Latn",
   territory: "US",
   transform: %{},
   language_variant: nil
 }}

Set the current process's locale for a specified backend.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1 or a Cldr.LanguageTag struct returned by Cldr.Locale.new!/2

• backend is any module that includes use Cldr and therefore is a Cldr backend module

See rfc5646 for the specification of a language tag and consult ./priv/cldr/rfc5646.abnf for the specification as implemented that includes the CLDR extensions for "u" (locales) and "t" (transforms).

Examples

iex> Cldr.put_locale(TestBackend.Cldr, "en")
{:ok,
 %Cldr.LanguageTag{
   canonical_locale_name: "en-Latn-US",
   cldr_locale_name: "en",
   language_subtags: [],
   extensions: %{},
   gettext_locale_name: "en",
   language: "en",
   locale: %{},
   private_use: [],
   rbnf_locale_name: "en",
   requested_locale_name: "en",
   script: "Latn",
   territory: "US",
   transform: %{},
   language_variant: nil
 }}

iex> Cldr.put_locale(TestBackend.Cldr, "invalid-locale")
{:error, {Cldr.LanguageTag.ParseError,
  "Expected a BCP47 language tag. Could not parse the remaining \"le\" starting at position 13"}}

Returns a list of all requested locale names.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

The list is the combination of configured locales, Gettext locales and the default locale.

See also known_locales/1 and all_locales/0

Returns an error tuple for an invalid calendar.

Arguments

• calendar is any calendar name not returned by Cldr.known_calendars/0

Returns

• {:error, {Cldr.UnknownCalendarError, message}}

Examples

iex> Cldr.unknown_calendar_error("invalid")
{Cldr.UnknownCalendarError, "The calendar name \"invalid\" is invalid"}

Returns an error tuple for an invalid currency.

Arguments

• currency is any currency code not returned by Cldr.known_currencies/0

Returns

• {:error, {Cldr.UnknownCurrencyError, message}}

Examples

iex> Cldr.unknown_currency_error("invalid")
{Cldr.UnknownCurrencyError, "The currency \"invalid\" is invalid"}

Returns a list of the locales names that are configured, but not known in CLDR.

Arguments

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Since there is a compile-time exception raise if there are any unknown locales this function should always return an empty list.

Returns an error tuple for an unknown number system.

Arguments

• number_system is any number system name not returned by Cldr.known_number_systems/0

Returns

• {:error, {Cldr.UnknownNumberSystemError, message}}

Examples

iex> Cldr.unknown_number_system_error "invalid"
{Cldr.UnknownNumberSystemError, "The number system \"invalid\" is invalid"}

iex> Cldr.unknown_number_system_error :invalid
{Cldr.UnknownNumberSystemError, "The number system :invalid is unknown"}

Returns an error tuple for an unknown number system type.

Options

• number_system_type is any number system type name not returned by Cldr.known_number_system_types/1

Returns

• {:error, {Cldr.UnknownNumberSystemTypeError, message}}

Examples

iex> Cldr.unknown_number_system_type_error("invalid")
{Cldr.UnknownNumberSystemTypeError, "The number system type \"invalid\" is invalid"}

iex> Cldr.unknown_number_system_type_error(:invalid)
{Cldr.UnknownNumberSystemTypeError, "The number system type :invalid is unknown"}

Returns an error tuple for an unknown territory.

Arguments

• territory is any territory code not returned by Cldr.known_territories/0

Returns

• {:error, {Cldr.UnknownTerritoryError, message}}

Examples

iex> Cldr.unknown_territory_error("invalid")
{Cldr.UnknownTerritoryError, "The territory \"invalid\" is unknown"}

Normalise and validate a calendar name.

Arguments

• calendar is any calendar name returned by Cldr.known_calendars/0

Returns

• {:ok, normalized_calendar_name} or

• {:error, {Cldr.UnknownCalendarError, message}}

Examples

iex> Cldr.validate_calendar(:gregorian)
{:ok, :gregorian}

iex> Cldr.validate_calendar(:invalid)
{:error, {Cldr.UnknownCalendarError, "The calendar name :invalid is invalid"}}

Normalize and validate a currency code.

Arguments

• currency is any ISO 4217 currency code as returned by Cldr.known_currencies/0 or any valid private use ISO4217 code which is a three-letter alphabetic code that starts with "X".

Returns

• {:ok, normalized_currency_code} or

• {:error, {Cldr.UnknownCurrencyError, message}}

Examples

iex> Cldr.validate_currency(:USD)
{:ok, :USD}

iex> Cldr.validate_currency("USD")
{:ok, :USD}

iex> Cldr.validate_currency(:XTC)
{:ok, :XTC}

iex> Cldr.validate_currency("xtc")
{:ok, :XTC}

iex> Cldr.validate_currency("invalid")
{:error, {Cldr.UnknownCurrencyError, "The currency \"invalid\" is invalid"}}

iex> Cldr.validate_currency(:invalid)
{:error, {Cldr.UnknownCurrencyError, "The currency :invalid is invalid"}}

Normalise and validate a gettext locale name.

Arguments

• locale_name is any valid locale name returned by Cldr.known_locale_names/1 or a Cldr.LanguageTag struct returned by Cldr.Locale.new!/2

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Returns

• {:ok, language_tag}

• {:error, reason}

Examples

Normalise and validate a locale name.

Arguments

• locale is any valid locale name returned by Cldr.known_locale_names/1 or a Cldr.LanguageTag struct returned by Cldr.Locale.new!/2

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Returns

• {:ok, language_tag}

• {:error, reason}

Examples

iex> Cldr.validate_locale("en", TestBackend.Cldr)
{:ok,
%Cldr.LanguageTag{
  canonical_locale_name: "en-Latn-US",
  cldr_locale_name: "en",
  extensions: %{},
  gettext_locale_name: "en",
  language: "en",
  locale: %{},
  private_use: [],
  rbnf_locale_name: "en",
  requested_locale_name: "en",
  script: "Latn",
  territory: "US",
  transform: %{},
  language_variant: nil
}}

iex> Cldr.validate_locale("zzz", TestBackend.Cldr)
{:error, {Cldr.UnknownLocaleError, "The locale \"zzz\" is not known."}}

Normalize and validate a number system name.

Arguments

• number_system is any number system name returned by Cldr.known_number_systems/0

Returns

• {:ok, normalized_number_system_name} or

• {:error, {exception, message}}

Examples

iex> Cldr.validate_number_system :latn
{:ok, :latn}

iex> Cldr.validate_number_system "latn"
{:ok, :latn}

iex> Cldr.validate_number_system "invalid"
{
  :error,
  {Cldr.UnknownNumberSystemError, "The number system :invalid is unknown"}
}

Normalise and validate a number system type.

Arguments

• number_system_type is any number system type returned by Cldr.known_number_system_types/1

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0. Note that Cldr.default_backend/0 will raise an exception if no :default_backend is configured under the :ex_cldr key in config.exs.

Returns

• {:ok, normalized_number_system_type} or

• {:error, {exception, message}}

Examples

iex> Cldr.validate_number_system_type(:default, TestBackend.Cldr)
{:ok, :default}

iex> Cldr.validate_number_system_type(:traditional, TestBackend.Cldr)
{:ok, :traditional}

iex> Cldr.validate_number_system_type(:latn, TestBackend.Cldr)
{
  :error,
  {Cldr.UnknownNumberSystemTypeError, "The number system type :latn is unknown"}
}

Normalise and validate a territory code.

Arguments

• territory is any territory code returned by Cldr.known_territories/0

Returns:

• {:ok, normalized_territory_code} or

• {:error, {Cldr.UnknownTerritoryError, message}}

Examples

iex> Cldr.validate_territory("en")
{:error, {Cldr.UnknownTerritoryError, "The territory \"en\" is unknown"}}

iex> Cldr.validate_territory("gb")
{:ok, :GB}

iex> Cldr.validate_territory("001")
{:ok, :"001"}

iex> Cldr.validate_territory(Cldr.Locale.new!("en", TestBackend.Cldr))
{:ok, :US}

iex> Cldr.validate_territory(%{})
{:error, {Cldr.UnknownTerritoryError, "The territory %{} is unknown"}}

Returns the version of the CLDR repository as a tuple

Example

iex> Cldr.version
{35, 1, 0}