package eio

You can search for identifiers within the package.

in-package search v0.2.0

eio
- Eio
  - Buf_read
    
    Syntax
  - Buf_write
    
    BE
    
    LE
  - Cancel
  - Condition
  - Debug
  - Domain_manager
    
    t
  - Exn
  - Fiber
    
    List
  - File
    
    ro
    
    rw
  - Flow
    
    close
    
    sink
    
    source
    
    two_way
  - Fs
    
    Unix_perm
    
    dir
    
    dir_with_close
  - Generic
    
    t
  - Mutex
  - Net
    
    Ipaddr
    
    V4
    
    V6
    
    Sockaddr
    
    datagram_socket
    
    listening_socket
    
    socket
    
    stream_socket
    
    t
  - Path
  - Private
    
    Ctf
    
    Control
    
    Debug
    
    Effects
    
    Fiber_context
    
    Suspend
    
    Waiters
  - Promise
  - Semaphore
  - Std
  - Stdenv
  - Stream
  - Switch
  - Time
    
    Timeout
    
    clock
eio.mock
- Eio_mock
  - Action
  - Backend
  - Clock
  - Flow
  - Handler
  - Net
eio.unix
- Eio_unix
  - Ctf
  - FD
  - Ipaddr
  - Private
eio.utils
- Eio_utils
  - Lf_queue
  - Suspended
  - Zzz
    
    Key

Legend:
Library
Module
Module type
Parameter
Class
Class type

Convert between Unix.file_descr and Eio objects.

val peek : < unix_fd.. > -> Unix.file_descr

peek x is the Unix file descriptor underlying x. The caller must ensure that they do not continue to use the result after x is closed.

val peek_opt : Eio.Generic.t -> Unix.file_descr option

peek_opt x is the Unix file descriptor underlying x, if any. The caller must ensure that they do not continue to use the result after x is closed.

val take : < unix_fd.. > -> Unix.file_descr

take x is like peek, but also marks x as closed on success (without actually closing the FD). x can no longer be used after this, and the caller is responsible for closing the FD.

val take_opt : Eio.Generic.t -> Unix.file_descr option

take_opt x is like peek_opt, but also marks x as closed on success (without actually closing the FD). x can no longer be used after this, and the caller is responsible for closing the FD.

val as_socket : 
  sw:Eio.Std.Switch.t ->
  close_unix:bool ->
  Unix.file_descr ->
  socket

as_socket ~sw ~close_unix:true fd is an Eio flow that uses fd. It can be cast to e.g. Eio.source for a one-way flow. The socket object will be closed when sw finishes.

parameter close_unix
If true, closing the object will also close the underlying FD. If false, the caller is responsible for keeping FD open until the object is closed.