Skip to content

Commit

Permalink
Merge pull request #492 from RyanGibb/mirage-ipaddr-conversion-docs
Browse files Browse the repository at this point in the history
Document mirage `Ipaddr` conversion
  • Loading branch information
talex5 authored Apr 20, 2023
2 parents 8ce7ede + 14e0bde commit b5d56f7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions lib_eio/net.mli
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ module Ipaddr : sig
'a
(** [fold ~v4 ~v6 t] is [v4 t] if [t] is an IPv4 address, or [v6 t] if it's an IPv6 address. *)

(** {2 Interoperability}
To convert to or from OCaml Unix addresses, use {!Eio_unix.Ipaddr}.
To interoperate with the {{:https://opam.ocaml.org/packages/ipaddr/} ipaddr} library:
- [Ipaddr.to_octets ipaddr_ip |> Eio.Net.Ipaddr.of_raw]
- [Ipaddr.of_octets_exn (eio_ip :> string)] *)

val of_raw : string -> v4v6
(** [of_raw addr] casts [addr] to an IP address.
@raise Invalid_argument if it is not 4 or 16 bytes long. *)
Expand Down

0 comments on commit b5d56f7

Please sign in to comment.