Cadastre v0.2.15

Cadastre.Country (Cadastre v0.2.15) View Source

Country implementation.

Link to this section Summary

Types

id()
t()

Functions

all()

Returns all countries.

ids()

Returns all ids (ISO_3166-1).

name(country, locale)

Returns country name translation for locale

new(id)

Returns %Cadastre.Country{} for valid id or nil for invalid id.

Link to this section Types

Link to this type

id()

View Source

Specs

id() :: <<_::16>>
Link to this type

t()

View Source

Specs

t() :: %Cadastre.Country{id: id()}

Link to this section Functions

Link to this function

all()

View Source

Specs

all() :: [t()]

Returns all countries.

Examples 

iex> Cadastre.Country.all() |> Enum.take(3)
[
  %Cadastre.Country{id: "AD"},
  %Cadastre.Country{id: "AE"},
  %Cadastre.Country{id: "AF"}
]

iex> Cadastre.Country.all() |> Enum.count()
250
Link to this function

ids()

View Source

Specs

ids() :: [id()]

Returns all ids (ISO_3166-1).

Examples 

iex> Cadastre.Country.ids() |> Enum.take(10)
["AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR"]
Link to this function

name(country, locale)

View Source

Specs

name(t(), Cadastre.Language.id()) :: String.t()

Returns country name translation for locale

Examples 

iex> Cadastre.Country.new("NL") |> Cadastre.Country.name("be")
"Нідэрланды"

iex> Cadastre.Country.new("NL") |> Cadastre.Country.name(":)")
"Netherlands"

iex> Cadastre.Country.name("something wrong", "be")
nil
Link to this function

new(id)

View Source

Specs

new(id() | any()) :: t() | nil

Returns %Cadastre.Country{} for valid id or nil for invalid id.

Examples 

iex> Cadastre.Country.new("NL")
%Cadastre.Country{id: "NL"}

iex> Cadastre.Country.new("nl")
%Cadastre.Country{id: "NL"}

iex> Cadastre.Country.new("xx")
nil