@spec available?() :: boolean()

Returns whether the NIF backend is available.

Returns

• true if the NIF shared library was loaded successfully.

• false if the NIF is not compiled or libphonenumber libraries are missing.

Examples

iex> is_boolean(Localize.PhoneNumber.Nif.available?())
true

@spec format(binary(), String.t()) :: {:ok, String.t()} | {:error, String.t()}

Formats a phone number in the specified format.

Arguments

• native_binary is the opaque binary from a parsed phone number.

• format_type is one of "e164", "international", "national", or "rfc3966".

Returns

• {:ok, formatted_string} on success.

• {:error, reason} on failure.

@spec parse(String.t(), String.t()) ::
  {:ok, pos_integer(), pos_integer(), String.t(), String.t(), binary()}
  | {:error, String.t()}

Parses a phone number string into its component parts.

Arguments

• number_string is the phone number string to parse.

• default_territory is the ISO 3166-1 alpha-2 territory code used when the number is not in international format.

Returns

• {:ok, country_code, national_number, extension, raw_input, native_binary} on successful parse.

• {:error, reason} if the number cannot be parsed.

@spec possible?(binary()) :: boolean()

Returns whether a phone number is a possible number.

A possible number has the right length for its type and territory but may not actually be allocated.

Arguments

• native_binary is the opaque binary from a parsed phone number.

Returns

• true if the phone number is possible.

• false otherwise.

@spec territory(binary()) :: String.t()

Returns the territory code for a phone number.

Arguments

• native_binary is the opaque binary from a parsed phone number.

Returns

• A two-letter ISO 3166-1 alpha-2 territory code string (e.g., "US", "GB"), or an empty string if the territory cannot be determined.

@spec type(binary()) :: String.t()

Returns the phone number type.

Arguments

• native_binary is the opaque binary from a parsed phone number.

Returns

• A string representing the type, such as "mobile", "fixed_line", "fixed_line_or_mobile", "toll_free", "premium_rate", "shared_cost", "voip", "personal_number", "pager", "uan", "voicemail", or "unknown".

@spec valid?(binary()) :: boolean()

Returns whether a phone number is valid.

Arguments

• native_binary is the opaque binary from a parsed phone number.

Returns

• true if the phone number is valid.

• false otherwise.

@spec valid_for_territory?(binary(), String.t()) :: boolean()

Returns whether a phone number is valid for a specific territory.

Arguments

• native_binary is the opaque binary from a parsed phone number.

• territory is the ISO 3166-1 alpha-2 territory code.

Returns

• true if the phone number is valid for the given territory.

• false otherwise.