package ipaddr-sexp

  1. Overview
  2. Docs
A library for manipulation of IP address representations using sexp


Dune Dependency






Sexp convertions for ipaddr


org:mirage org:xapi-project

Published: 15 Mar 2023


ipaddr: IP and MAC address manipulation

A library for manipulation of IP and MAC address representations.


  • ounit2-based tests

  • IPv4 and IPv6 support

  • IPv4 and IPv6 CIDR prefix support

  • IPv4 and IPv6 CIDR-scoped address support

  • Ipaddr.V4 and Ipaddr.V4.Prefix modules are Map.OrderedType

  • Ipaddr.V6 and Ipaddr.V6.Prefix modules are Map.OrderedType

  • Ipaddr and Ipaddr.Prefix modules are Map.OrderedType

  • Ipaddr_unix in findlib subpackage ipaddr.unix provides compatibility with the standard library Unix module

  • Ipaddr_top in findlib subpackage provides top-level pretty printers

  • IP address scope classification

  • IPv4-mapped addresses in IPv6 (::ffff:0:0/96) are an embedding of IPv4

  • MAC-48 (Ethernet) address support

  • Macaddr is a Map.OrderedType

  • All types have sexplib serializers/deserializers optionally via the Ipaddr_sexp and Macaddr_sexp libraries.


There are the following opam packages included:

  • ipaddr: the Ipaddr and associated modules

  • ipaddr-sexp

  • ipaddr-cstruct

  • macaddr: the Macaddr 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: The Ipaddr module for IPv4/6 manipulation.

  • Toplevel printers for Ipaddr.

  • ipaddr-cstruct: The Ipaddr_cstruct module

  • macaddr: The Macaddr module for MAC address manipulation.

  • Toplevel printers for Macaddr.

  • macaddr-cstruct: The Macaddr_cstruct module

  • ipaddr-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.


Dependencies (5)

  1. sexplib0
  2. ppx_sexp_conv >= "v0.9.0"
  3. ipaddr = version
  4. dune >= "1.9.0"
  5. ocaml >= "4.08.0"

Dev Dependencies (2)

  1. ounit2 with-test
  2. ipaddr-cstruct with-test & = version

Used by (8)

  1. charrua >= "1.1.0"
  2. charrua-server >= "1.1.0"
  3. conduit >= "1.5.0" & != "3.0.0"
  4. conduit-async >= "4.0.1"
  5. conduit-lwt-unix >= "1.5.0"
  6. conduit-mirage != "3.0.0"
  7. mirage-conduit >= "3.2.0"
  8. tls >= "0.15.0" & < "0.17.0"




Innovation. Community. Security.