Representation of IP addresses and subnets.
Find a file
2023-07-07 23:23:10 +12:00
config chore: fix git_ops configuration. 2023-01-17 10:58:55 +13:00
lib chore: Run Elixir 1.15 formatter. 2023-06-22 09:08:12 +12:00
test fix: correctly validate IPv4 netmasks 2022-09-23 11:45:19 +12:00
.formatter.exs Update deps 2018-09-04 03:25:04 +00:00
.gitignore Initial parsing of various formats for IP addresses. 2017-10-08 19:07:51 +13:00
.gitlab-ci.yml chore: set up git_ops and auto-releasing 2021-12-08 13:31:45 +13:00
CHANGELOG.md chore: release version v2.0.0 2023-01-16 22:03:49 +00:00
LICENSE.md chore!: Relicense to HL3-FULL. 2023-01-17 11:00:21 +13:00
mix.exs chore(deps): update dependency ex_doc to ~> 0.30 2023-07-07 23:23:10 +12:00
mix.lock chore(deps): update dependency ex_doc to ~> 0.30 2023-07-07 23:23:10 +12:00
README.md chore: release version v2.0.0 2023-01-16 22:03:49 +00:00
renovate.json chore: update renovate.json. 2021-12-09 11:17:01 +13:00

IP

pipeline status Hex.pm Hippocratic License HL3-FULL

IP, IP, Ooray! Simple IP Address representations.

Installation

If available in Hex, the package can be installed by adding ip to your list of dependencies in mix.exs:

def deps do
  [
    {:ip, "~> 2.0.0"}
  ]
end

Usage

ip provides representations for IP addresses and subnets for Elixir with a bunch of helpful stuff tacked on the side.

iex> ~i(192.0.2.1)
#IP.Address<192.0.2.1 DOCUMENTATION>

iex> ~i(2001:db8::)
#IP.Address<2001:db8:: DOCUMENTATION>

iex> outside = ~i(2001:db8::/64)
...> inside  = IP.Prefix.eui_64!(outside, "60:f8:1d:ad:d8:90")
...> IP.Prefix.contains_address?(outside, inside)
true

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/ip.

License

This software is licensed under the terms of the HL3-FULL, see the LICENSE.md file included with this package for the terms.

This license actively proscribes this software being used by and for some industries, countries and activities. If your usage of this software doesn't comply with the terms of this license, then contact me with the details of your use-case to organise the purchase of a license - the cost of which may include a donation to a suitable charity or NGO.