liaison v0.1.0 Liaison.IP View Source

Allow the conversion of common IP formats to and from

string: "1.2.3.4"
component: {1, 2, 3, 4}
integer: 16909060

Input formats can be equal to output formats

Example

iex> Liaison.IP.as_string("1.2.3.4")
"1.2.3.4"

Link to this section Summary

Types

format()

ip()

ip_addr()

ip_comp()

Functions

as_components(ip_addr)

Converts any valid address into a tuple {a, b, c, d}

as_integer(ip_addr)

Converts any valid address into an integer

as_string(ip_addr)

Converts any valid address into a string a.b.c.d

get_ipv4_addr(pos \\ 0)

Returns the localhost ip address in component form. If there is more than one ip address for the machine, the nth can be returned. Else nil

is_valid?(ip_addr)

Returns true if the given address is valid. This checks if the format is correct, not if the address is functionally valid or accessible

to_ip_range(from, to, format \\ :integer)

Creates a range of integer ip addresses between the given addresses. Inclusivity: [from, to]

Link to this section Types

format()

format() :: :integer | :components | :string

ip()

ip() :: integer()

ip_addr()

ip_addr() :: ip() | ip_comp() | String.t()

ip_comp()

ip_comp() :: {integer(), integer(), integer(), integer()}

Link to this section Functions

as_components(ip_addr)

as_components(ip_addr()) :: ip_comp()

Converts any valid address into a tuple {a, b, c, d}

Example

iex> Liaison.IP.as_components("1.2.3.4")
{1, 2, 3, 4}

iex> Liaison.IP.as_components(16909060)
{1, 2, 3, 4}

iex> Liaison.IP.as_components({1, 2, 3, 4})
{1, 2, 3, 4}

as_integer(ip_addr)

as_integer(ip_addr()) :: ip()

Converts any valid address into an integer

Example

iex> Liaison.IP.as_integer("1.2.3.4")
16909060

iex> Liaison.IP.as_integer(16909060)
16909060

iex> Liaison.IP.as_integer({1, 2, 3, 4})
16909060

as_string(ip_addr)

as_string(ip_addr()) :: String.t()

Converts any valid address into a string a.b.c.d

Example

iex> Liaison.IP.as_string("1.2.3.4")
"1.2.3.4"

iex> Liaison.IP.as_string(16909060)
"1.2.3.4"

iex> Liaison.IP.as_string({1, 2, 3, 4})
"1.2.3.4"

get_ipv4_addr(pos \\ 0)

get_ipv4_addr(integer()) :: ip_comp() | nil

Returns the localhost ip address in component form. If there is more than one ip address for the machine, the nth can be returned. Else nil

is_valid?(ip_addr)

is_valid?(any()) :: boolean()

Returns true if the given address is valid. This checks if the format is correct, not if the address is functionally valid or accessible

Example

iex> Liaison.IP.is_valid?("1.2.3.4")
true

iex> Liaison.IP.is_valid?({1, 2, 3, 400})
false

to_ip_range(from, to, format \\ :integer)

to_ip_range(ip_addr(), ip_addr(), format()) :: [ip()] | {:error, String.t()}

Creates a range of integer ip addresses between the given addresses. Inclusivity: [from, to]

Example

iex> Liaison.IP.to_ip_range("1.2.3.4", "1.2.3.6", :string)
["1.2.3.4", "1.2.3.5", "1.2.3.6"]

iex> Liaison.IP.to_ip_range("1.2.3.6", "1.2.3.4")
{:error, "ip1 > ip2"}