Skip to content

Document mirage Ipaddr conversion #492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2023
Merged

Document mirage Ipaddr conversion #492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions lib_eio/net.mli
View file
Open in desktop
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