Cldr Territories v1.3.1 Cldr.Territory View Source
Supports the CLDR Territories definitions which provide the localization of many territories.
Link to this section Summary
Functions
Returns a list of available styles
Returns the available territories for a given locale
Lists children(s) for the given territory code.
Returns {:ok, list}
if successful, otherwise {:error, reason}
The same as children/2
, but raises an exception if it fails
Checks relationship between two territories, where the first argument is the parent
and second the child
.
Returns true
if successful, otherwise false
Returns a list of country codes
Localized string for the given LanguageTag.t
.
Returns {:ok, String.t}
if successful, otherwise {:error, reason}
The same as from_language_tag/2
, but raises an exception if it fails
Localized string for the given territory code.
Returns {:ok, String.t}
if successful, otherwise {:error, reason}
The same as from_territory_code/2
, but raises an exception if it fails
Maps territory info for the given territory code.
Returns {:ok, map}
if successful, otherwise {:error, reason}
The same as info/1
, but raises an exception if it fails
Returns a map of all known territories in a given locale
Lists parent(s) for the given territory code.
Returns {:ok, list}
if successful, otherwise {:error, reason}
The same as parent/2
, but raises an exception if it fails
A helper method to get a territory’s currency code
if a territory has multiply currencies then the oldest active currency is returned.
Returns {:ok, code}
if successful, otherwise {:error, reason}
The same as to_currency_code/2
, but raises an exception if it fails
A helper method to get a territory’s currency codes.
Returns {:ok, list}
if successful, otherwise {:error, reason}
The same as to_currency_codes/2
, but raises an exception if it fails
Unicode flag for the given territory code.
Returns {:ok, flag}
if successful, otherwise {:error, reason}
The same as to_unicode_flag/1
, but raises an exception if it fails
Translate a LanguageTag.t into a localized string from one locale to another.
Returns {:ok, result}
if successful, otherwise {:error, reason}
The same as translate_language_tag/2
, but raises an exception if it fails
Translate a localized string from one locale to another.
Returns {:ok, result}
if successful, otherwise {:error, reason}
The same as translate_territory/3
, but raises an exception if it fails
Link to this section Types
atom_binary_charlist() :: atom() | binary() | charlist()
atom_binary_tag() :: atom() | binary() | Cldr.LanguageTag.t()
binary_charlist_integer() :: binary() | charlist() | pos_integer()
Link to this section Functions
Returns a list of available styles.
Example
iex> Cldr.Territory.available_styles
[:short, :standard, :variant]
available_territories(binary_tag()) :: [atom()] | {:error, error()}
Returns the available territories for a given locale.
locale
is any configured locale. SeeCldr.known_locale_names/0
. The default isCldr.get_current_locale/0
Example
=> Cldr.Territory.available_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, ...]
=> Cldr.Territory.available_territories("zzz")
{:error, {Cldr.UnknownLocaleError, "The locale "zzz" is not known."}}
children(atom_binary_tag(), as_options()) :: {:ok, atom_binary_charlist()} | {:error, error()}
Lists children(s) for the given territory code.
Returns {:ok, list}
if successful, otherwise {:error, reason}
.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.children(:EU)
{:ok,
[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GB, :GR, :HR, :HU, :IE,
:IT, :LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]}
iex> Cldr.Territory.children(:ZZZ)
{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
iex> Cldr.Territory.children(:GB)
{:error, {Cldr.UnknownParentError, "The territory :GB has no children"}}
children!(atom_binary_tag(), as_options()) :: [atom_binary_charlist()] | no_return()
The same as children/2
, but raises an exception if it fails.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.children!(:EU)
[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GB, :GR, :HR, :HU, :IE, :IT,
:LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]
Checks relationship between two territories, where the first argument is the parent
and second the child
.
Returns true
if successful, otherwise false
.
Example
iex> Cldr.Territory.contains?(:EU, :DK)
true
iex> Cldr.Territory.contains?(:DK, :EU)
false
country_codes(as_options()) :: [atom_binary_charlist()]
Returns a list of country codes.
options
are:as: :atom
as: :binary
as: :charlist
Example
=> Cldr.Territory.country_codes()
[:AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :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, :CR, :CU, ...]
Localized string for the given LanguageTag.t
.
Returns {:ok, String.t}
if successful, otherwise {:error, reason}
.
options
are:style
is one of those returned byCldr.Territory.available_styles/0
. The current styles are:short
,:standard
and:variant
. The default is:standard
Example
iex> Cldr.Territory.from_language_tag(Cldr.get_current_locale())
{:ok, "World"}
iex> Cldr.Territory.from_language_tag(Cldr.get_current_locale(), [style: :short])
{:error, {Cldr.UnknownStyleError, "The style :short is unknown"}}
iex> Cldr.Territory.from_language_tag(Cldr.get_current_locale(), [style: :ZZZ])
{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}
iex> Cldr.Territory.from_language_tag(Cldr.get_current_locale(), [style: "ZZZ"])
{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
The same as from_language_tag/2
, but raises an exception if it fails.
Example
iex> Cldr.Territory.from_language_tag!(Cldr.get_current_locale())
"World"
from_territory_code(atom_binary_tag(), options()) :: {:ok, binary()} | {:error, error()}
Localized string for the given territory code.
Returns {:ok, String.t}
if successful, otherwise {:error, reason}
.
options
are:locale
is any configured locale. SeeCldr.known_locale_names/0
. The default isCldr.get_current_locale/0
style
is one of those returned byCldr.Territory.available_styles/0
. The current styles are:short
,:standard
and:variant
. The default is:standard
Example
iex> Cldr.Territory.from_territory_code(:GB)
{:ok, "United Kingdom"}
iex> Cldr.Territory.from_territory_code(:GB, [style: :short])
{:ok, "UK"}
iex> Cldr.Territory.from_territory_code(:GB, [style: :ZZZ])
{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}
iex> Cldr.Territory.from_territory_code(:GB, [style: "ZZZ"])
{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
iex> Cldr.Territory.from_territory_code(:GB, [locale: "pt"])
{:ok, "Reino Unido"}
iex> Cldr.Territory.from_territory_code(:GB, [locale: :zzz])
{:error, {Cldr.UnknownLocaleError, "The locale :zzz is not known."}}
iex> Cldr.Territory.from_territory_code(:GB, [locale: "zzz"])
{:error, {Cldr.UnknownLocaleError, "The locale \"zzz\" is not known."}}
from_territory_code!(atom_binary_tag(), options()) :: binary() | no_return()
The same as from_territory_code/2
, but raises an exception if it fails.
Example
iex> Cldr.Territory.from_territory_code!(:GB)
"United Kingdom"
iex> Cldr.Territory.from_territory_code!(:GB, [style: :short])
"UK"
iex> Cldr.Territory.from_territory_code!(:GB, [locale: "pt"])
"Reino Unido"
Maps territory info for the given territory code.
Returns {:ok, map}
if successful, otherwise {:error, reason}
.
Example
iex> Cldr.Territory.info(:GB)
{:ok, %{currency: [GBP: %{from: ~D[1694-07-27]}], gdp: 2788000000000,
language_population: %{"bn" => %{population_percent: 0.67},
"cy" => %{official_status: "official_regional",
population_percent: 0.77}, "de" => %{population_percent: 6},
"el" => %{population_percent: 0.34},
"en" => %{official_status: "official", population_percent: 99},
"fr" => %{population_percent: 19},
"ga" => %{official_status: "official_regional",
population_percent: 0.026},
"gd" => %{official_status: "official_regional",
population_percent: 0.099, writing_percent: 5},
"it" => %{population_percent: 0.34},
"ks" => %{population_percent: 0.19},
"kw" => %{population_percent: 0.0031},
"ml" => %{population_percent: 0.035},
"pa" => %{population_percent: 0.79},
"sco" => %{population_percent: 2.7, writing_percent: 5},
"syl" => %{population_percent: 0.51},
"yi" => %{population_percent: 0.049},
"zh-Hant" => %{population_percent: 0.54}}, literacy_percent: 99,
measurement_system: "UK", paper_size: "A4", population: 64769500,
telephone_country_code: 44, temperature_measurement: "metric"}}
The same as info/1
, but raises an exception if it fails.
Example
iex> Cldr.Territory.info!(:GB)
%{currency: [GBP: %{from: ~D[1694-07-27]}], gdp: 2788000000000,
language_population: %{"bn" => %{population_percent: 0.67},
"cy" => %{official_status: "official_regional",
population_percent: 0.77}, "de" => %{population_percent: 6},
"el" => %{population_percent: 0.34},
"en" => %{official_status: "official", population_percent: 99},
"fr" => %{population_percent: 19},
"ga" => %{official_status: "official_regional",
population_percent: 0.026},
"gd" => %{official_status: "official_regional",
population_percent: 0.099, writing_percent: 5},
"it" => %{population_percent: 0.34},
"ks" => %{population_percent: 0.19},
"kw" => %{population_percent: 0.0031},
"ml" => %{population_percent: 0.035},
"pa" => %{population_percent: 0.79},
"sco" => %{population_percent: 2.7, writing_percent: 5},
"syl" => %{population_percent: 0.51},
"yi" => %{population_percent: 0.049},
"zh-Hant" => %{population_percent: 0.54}}, literacy_percent: 99,
measurement_system: "UK", paper_size: "A4", population: 64769500,
telephone_country_code: 44, temperature_measurement: "metric"}
known_territories(binary_tag()) :: map() | {:error, error()}
Returns a map of all known territories in a given locale.
locale
is any configured locale. SeeCldr.known_locale_names/0
. The default isCldr.get_currenct_locale/0
Example
=> Cldr.Territory.known_territories()
%{SN: %{standard: "Senegal"}, "061": %{standard: "Polynesia"},
BH: %{standard: "Bahrain"}, TM: %{standard: "Turkmenistan"},
"009": %{standard: "Oceania"}, CW: %{standard: "Curaçao"},
FR: %{standard: "France"}, TN: %{standard: "Tunisia"},
FI: %{standard: "Finland"}, BF: %{standard: "Burkina Faso"},
"155": %{standard: "Western Europe"}, GL: %{standard: "Greenland"},
VI: %{standard: "U.S. Virgin Islands"}, ZW: %{standard: "Zimbabwe"},
AR: %{standard: "Argentina"}, SG: %{standard: "Singapore"},
SZ: %{standard: "Swaziland"}, ID: %{standard: "Indonesia"},
NR: %{standard: "Nauru"}, RW: %{standard: "Rwanda"},
TR: %{standard: "Turkey"}, IS: %{standard: "Iceland"},
ME: %{standard: "Montenegro"}, AW: %{standard: "Aruba"},
PY: %{standard: "Paraguay"}, "145": %{standard: "Western Asia"},
CG: %{standard: "Congo - Brazzaville", variant: "Congo (Republic)"},
LT: %{standard: "Lithuania"}, SA: %{standard: "Saudi Arabia"},
MZ: %{standard: "Mozambique"}, NU: %{standard: "Niue"},
NG: %{standard: "Nigeria"}, CK: %{standard: "Cook Islands"},
ZM: %{standard: "Zambia"}, LK: %{standard: "Sri Lanka"},
UY: %{standard: "Uruguay"}, YE: %{standard: "Yemen"},
"011": %{standard: "Western Africa"},
CC: %{standard: "Cocos (Keeling) Islands"}, BY: %{standard: "Belarus"},
IL: %{standard: "Israel"}, KY: %{standard: "Cayman Islands"},
GN: %{standard: "Guinea"}, VN: %{standard: "Vietnam"},
PE: %{standard: "Peru"}, HU: %{standard: "Hungary"},
HN: %{standard: "Honduras"}, GI: %{standard: "Gibraltar"},
"142": %{standard: "Asia"}, "029": %{...}, ...}
=> Cldr.Territory.known_territories("zzz")
{:error, {Cldr.UnknownLocaleError, "The locale "zzz" is not known."}}
parent(atom_binary_tag(), as_options()) :: {:ok, atom_binary_charlist()} | {:error, error()}
Lists parent(s) for the given territory code.
Returns {:ok, list}
if successful, otherwise {:error, reason}
.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.parent(:GB)
{:ok, [:"154", :EU, :UN]}
iex> Cldr.Territory.parent(:ZZZ)
{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}
iex> Cldr.Territory.parent(Cldr.get_current_locale())
{:error, {Cldr.UnknownChildrenError, "The territory :\"001\" has no parent(s)"}}
parent!(atom_binary_tag(), as_options()) :: [atom_binary_charlist()] | no_return()
The same as parent/2
, but raises an exception if it fails.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.parent!(:GB)
[:"154", :EU, :UN]
to_currency_code(atom_binary_tag(), as_options()) :: {:ok, atom_binary_charlist()} | {:error, error()}
A helper method to get a territory’s currency code
if a territory has multiply currencies then the oldest active currency is returned.
Returns {:ok, code}
if successful, otherwise {:error, reason}
.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.to_currency_code(:US)
{:ok, :USD}
iex> Cldr.Territory.to_currency_code("cu")
{:ok, :CUP}
to_currency_code!(atom_binary_tag(), as_options()) :: atom_binary_charlist() | no_return()
The same as to_currency_code/2
, but raises an exception if it fails.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.to_currency_code!(:US)
:USD
iex> Cldr.Territory.to_currency_code!(:US, as: :charlist)
'USD'
iex> Cldr.Territory.to_currency_code!("PS")
:ILS
iex> Cldr.Territory.to_currency_code!("PS", as: :binary)
"ILS"
to_currency_codes(atom_binary_tag(), as_options()) :: {:ok, [atom_binary_charlist()]} | {:error, error()}
A helper method to get a territory’s currency codes.
Returns {:ok, list}
if successful, otherwise {:error, reason}
.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.to_currency_codes(:US)
{:ok, [:USD]}
iex> Cldr.Territory.to_currency_codes("cu")
{:ok, [:CUP, :CUC]}
to_currency_codes!(atom_binary_tag(), as_options()) :: [atom_binary_charlist()] | no_return()
The same as to_currency_codes/2
, but raises an exception if it fails.
options
are:as: :atom
as: :binary
as: :charlist
Example
iex> Cldr.Territory.to_currency_codes!(:US)
[:USD]
iex> Cldr.Territory.to_currency_codes!(:US, as: :charlist)
['USD']
iex> Cldr.Territory.to_currency_codes!("PS")
[:ILS, :JOD]
iex> Cldr.Territory.to_currency_codes!("PS", as: :binary)
["ILS", "JOD"]
to_unicode_flag(atom_binary_tag() | {:ok, atom()} | {:error, error()}) :: {:ok, binary()} | {:error, error()}
Unicode flag for the given territory code.
Returns {:ok, flag}
if successful, otherwise {:error, reason}
.
Example
iex> Cldr.Territory.to_unicode_flag(:US)
{:ok, "🇺🇸"}
iex> Cldr.Territory.to_unicode_flag(:EZ)
{:error, {Cldr.UnknownFlagError, "The territory :EZ has no flag"}}
to_unicode_flag!(atom_binary_tag()) :: binary() | no_return()
The same as to_unicode_flag/1
, but raises an exception if it fails.
Example
iex> Cldr.Territory.to_unicode_flag!(:US)
"🇺🇸"
Translate a LanguageTag.t into a localized string from one locale to another.
Returns {:ok, result}
if successful, otherwise {:error, reason}
.
options
are:locale
is any configured locale. SeeCldr.known_locale_names/0
. The default isCldr.get_current_locale/0
style
is one of those returned byCldr.Territory.available_styles/0
. The current styles are:short
,:standard
and:variant
. The default is:standard
Example
iex> Cldr.Territory.translate_language_tag(Cldr.get_current_locale())
{:ok, "World"}
iex> Cldr.Territory.translate_language_tag(Cldr.get_current_locale(), [locale: Cldr.Locale.new!("pt")])
{:ok, "Mundo"}
The same as translate_language_tag/2
, but raises an exception if it fails.
Example
iex> Cldr.Territory.translate_language_tag!(Cldr.get_current_locale())
"World"
iex> Cldr.Territory.translate_language_tag!(Cldr.get_current_locale(), [locale: Cldr.Locale.new!("pt")])
"Mundo"
translate_territory(binary(), binary_tag(), binary_tag()) :: {:ok, binary()} | {:error, error()}
Translate a localized string from one locale to another.
Returns {:ok, result}
if successful, otherwise {:error, reason}
.
to_locale
is any configured locale. SeeCldr.known_locale_names/0
. The default isCldr.get_current_locale/0
Example
iex> Cldr.Territory.translate_territory("Reino Unido", "pt")
{:ok, "UK"}
iex> Cldr.Territory.translate_territory("United Kingdom", "en", "pt")
{:ok, "Reino Unido"}
iex> Cldr.Territory.translate_territory("Reino Unido", :zzz)
{:error, {Cldr.UnknownLocaleError, "The locale :zzz is not known."}}
iex> Cldr.Territory.translate_territory("United Kingdom", "en", "zzz")
{:error, {Cldr.UnknownLocaleError, "The locale \"zzz\" is not known."}}
translate_territory!(binary(), binary_tag(), binary_tag()) :: binary() | no_return()
The same as translate_territory/3
, but raises an exception if it fails.
Example
iex> Cldr.Territory.translate_territory!("Reino Unido", "pt")
"UK"
iex> Cldr.Territory.translate_territory!("United Kingdom", "en", "pt")
"Reino Unido"