package macaddr-sexp
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=5a66291bf710b45f7e9550ecd562227af519d5fefe899da1b9fb1d0f51c735ea
sha512=c0c564529bceeb1263a6200f5f86c53ee38874a7cd3ba6dd4b435cb87e0247ba85b0ee46ab5f517ef81aa05f4187d2ba20d10013d3faa2763b64daf85046ae96
README.md.html
ipaddr: IP and MAC address manipulation
A library for manipulation of IP and MAC address representations.
Features:
ounit2-based tests
IPv4 and IPv6 support
IPv4 and IPv6 CIDR prefix support
IPv4 and IPv6 CIDR-scoped address support
Ipaddr.V4
andIpaddr.V4.Prefix
modules areMap.OrderedType
Ipaddr.V6
andIpaddr.V6.Prefix
modules areMap.OrderedType
Ipaddr
andIpaddr.Prefix
modules areMap.OrderedType
Ipaddr_unix
in findlib subpackageipaddr.unix
provides compatibility with the standard libraryUnix
moduleIpaddr_top
in findlib subpackageipaddr.top
provides top-level pretty printersIP address scope classification
IPv4-mapped addresses in IPv6 (::ffff:0:0/96) are an embedding of IPv4
MAC-48 (Ethernet) address support
Macaddr
is aMap.OrderedType
All types have sexplib serializers/deserializers optionally via the
Ipaddr_sexp
andMacaddr_sexp
libraries.
Usage
There are the following opam packages included:
ipaddr
: theIpaddr
and associated modulesipaddr-sexp
ipaddr-cstruct
macaddr
: theMacaddr
and associated modules.macaddr-sexp
macaddr-cstruct
There are the following ocamlfind libraries included as part of this repository, included as part of the respective opam packages.
ipaddr
: TheIpaddr
module for IPv4/6 manipulation.ipaddr.top
: Toplevel printers for Ipaddr.ipaddr-cstruct
: TheIpaddr_cstruct
modulemacaddr
: TheMacaddr
module for MAC address manipulation.macaddr.top
: Toplevel printers for Macaddr.macaddr-cstruct
: TheMacaddr_cstruct
moduleipaddr-sexp
: S-expression converters for Ipaddr.macaddr-sexp
: S-expression converters for Macaddr.
Installation and development
The packages are released to the opam-repository. An opam install ipaddr
(or any other above mentioned package) will install it. If you want to install the latest development commit, opam pin add ipaddr --dev
will do this.
A local build, after a git clone
can be done with dune build
, a dune runtest
compiles and executes the testsuite. If dependencies are missing, opam install (-t) --deps-only .
in the cloned directory will install them.
The auto-formatter ocamlformat
is used, please execute dune build @fmt --auto-promote
before submitting a pull request.
Contact
API Documentation: http://docs.mirage.io/ipaddr/
Discussion: https://discuss.ocaml.org with the
mirageos
tag.