Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c-rack/cidr-elixir
Classless Inter-Domain Routing (CIDR) for Elixir
https://github.com/c-rack/cidr-elixir
Last synced: 1 day ago
JSON representation
Classless Inter-Domain Routing (CIDR) for Elixir
- Host: GitHub
- URL: https://github.com/c-rack/cidr-elixir
- Owner: c-rack
- License: mpl-2.0
- Created: 2015-04-05T19:31:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T18:24:49.000Z (6 months ago)
- Last Synced: 2024-12-03T20:02:21.489Z (9 days ago)
- Language: Elixir
- Homepage:
- Size: 86.9 KB
- Stars: 45
- Watchers: 7
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Classless Inter-Domain Routing (CIDR) for Elixir. (Text and Numbers)
- fucking-awesome-elixir - cidr - Classless Inter-Domain Routing (CIDR) for Elixir. (Text and Numbers)
- awesome-elixir - cidr - Classless Inter-Domain Routing (CIDR) for Elixir. (Text and Numbers)
README
# CIDR
[](https://hex.pm/packages/cidr)
[](https://hex.pm/packages/cidr)
[](https://travis-ci.org/c-rack/cidr-elixir)
[](https://coveralls.io/github/c-rack/cidr-elixir?branch=)
[](http://inch-ci.org/github/c-rack/cidr-elixir)
[Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
(CIDR) utilities for [Elixir](http://www.elixir-lang.org/)
## Setup
To use this library, just add `:cidr` as a dependency to your `mix.exs` file:
```elixir
defp deps do
[
{:cidr, ">= 1.1.0"}
]
end
```
## Usage
Passing an IP address string into `CIDR.parse` returns a `%CIDR{}` struct.
It contains the first and the last address of the range as Erlang IP tuples,
the amount of hosts the range covers and the network mask.
```elixir
iex(1)> cidr = "1.2.3.4/24" |> CIDR.parse
%CIDR{first: {1, 2, 3, 0}, last: {1, 2, 3, 255}, hosts: 256, mask: 24}
```
You can query the struct for all of its fields:
```elixir
iex(2)> cidr.first
{1, 2, 3, 0}
iex(3)> cidr.hosts
256
```
And use it to see if other IP addresses fall in the same range:
```elixir
iex(4)> cidr |> CIDR.match!({1,2,3,100})
true
iex(5)> cidr |> CIDR.match!({1,2,4,1})
false
```
The `match!/2` function also supports IP strings:
```elixir
iex(6)> cidr |> CIDR.match!("1.2.3.100")
true
iex(7)> cidr |> CIDR.match!("1.2.4.1")
false
```
Please note that `match!/2` throws an `ArgumentError` when you pass in a value
that does not represent a valid IP address or when you try to match an IPv4
address with an IPv6 range and vice-versa.
We also provide `match/2`, a non-throwing version that returns tagged tuples:
```elixir
iex(8)> cidr |> CIDR.match("1.2.3.100")
{:ok, true}
iex(9)> cidr |> CIDR.match("1.2.4.1")
{:ok, false}
iex(10)> cidr |> CIDR.match("1.2.3.1000")
{:error, "Tuple is not a valid IP address."}
```
IPv4 deaggregation works as well. It returns a list of the largest possible networks for an IPv4 range in the format of `$first_ip-$last_ip`:
```elixir
iex(1)> CIDR.parse_range("192.168.1.0-192.168.2.0")
[
%CIDR{first: {192, 168, 1, 0}, hosts: 256, last: {192, 168, 1, 255}, mask: 24},
%CIDR{first: {192, 168, 2, 0}, hosts: 1, last: {192, 168, 2, 0}, mask: 32}
]
```
## Contribution
See [Collective Code Construction Contract (C4)](http://rfc.zeromq.org/spec:42/C4/)
## License
[Mozilla Public License 2.0](LICENSE)