package eio

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Interoperability

package eio

eio
- Eio
  - Buf_read
    
    BE
    
    LE
    
    Syntax
  - Buf_write
    
    BE
    
    LE
  - Cancel
  - Condition
  - Debug
  - Domain_manager
    
    Pi
    
    MGR
  - Exn
    
    Backend
  - Fiber
    
    List
  - File
    
    Pi
    
    READ
    
    WRITE
    
    Stat
    
    Unix_perm
  - Flow
    
    Pi
    
    SHUTDOWN
    
    SINK
    
    SOURCE
    
    TWO_WAY
  - Fs
    
    Pi
    
    DIR
  - Lazy
  - Mutex
  - Net
    
    Ipaddr
    
    V4
    
    V6
    
    Pi
    
    DATAGRAM_SOCKET
    
    LISTENING_SOCKET
    
    NETWORK
    
    STREAM_SOCKET
    
    Sockaddr
  - Path
  - Pool
  - Private
    
    Broadcast
    
    Cells
    
    CELL
    
    Make
    
    Cell
    
    Debug
    
    Dla
    
    Effects
    
    Fiber_context
    
    Suspend
    
    Trace
  - Process
    
    Pi
    
    MGR
    
    PROCESS
  - Promise
  - Resource
  - Semaphore
  - Std
  - Stdenv
  - Stream
  - Switch
  - Time
    
    Mono
    
    Pi
    
    CLOCK
    
    Timeout
eio.mock
- Eio_mock
  - Action
  - Backend
  - Clock
    
    Mono
    
    S
  - Domain_manager
  - Flow
  - Handler
  - Net
eio.runtime_events
- Eio_runtime_events
eio.unix
- Eio_unix
  - Fd
  - Net
    
    Ipaddr
  - Pi
    
    DATAGRAM_SOCKET
    
    FLOW
    
    LISTENING_SOCKET
    
    STREAM_SOCKET
  - Private
    
    Rcfd
  - Process
    
    Make_mgr
    
    X
    
    Pi
    
    MGR
  - Resource
  - Stdenv
eio.utils
- Eio_utils
  - Lf_queue
  - Suspended
  - Zzz
    
    Key

Legend:
Library
Module
Module type
Parameter
Class
Class type

IP addresses.

type 'a t = private string

The raw bytes of the IP address. It is either 4 bytes long (for an IPv4 address) or 16 bytes long (for IPv6).

module V4 : sig ... end

IPv4 addresses.

module V6 : sig ... end

IPv6 addresses.

val pp : [< `V4 | `V6 ] t Fmt.t

pp formats IP addresses. For IPv6 addresses, it follows http://tools.ietf.org/html/rfc5952.

type v4v6 = [ `V4 | `V6 ] t

val fold : 
  v4:([> `V4 ] t -> 'a) ->
  v6:([> `V6 ] t -> 'a) ->
  [< `V4 | `V6 ] t ->
  'a

fold ~v4 ~v6 t is v4 t if t is an IPv4 address, or v6 t if it's an IPv6 address.

Interoperability

To convert to or from OCaml Unix addresses, use Eio_unix.Ipaddr.

To interoperate with the 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.

raises Invalid_argument
if it is not 4 or 16 bytes long.