package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (19)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-0.6.tbz
sha256=ead3eea352dd3d7d11a81ffdbeee6ca94d5e6b3f46de264b4e59689360b3ef38
sha512=0543643da7861f533f9b7ebee8aa30a6868b48ae1e19211666a9b860e9ff8d8a9e135f214a4603d0329f2027277701f6ffd900b6fba3405a538eebc301edaf29

doc/eio.unix/Eio_unix/FD/index.html

Module Eio_unix.FDSource

Convert between Unix.file_descr and Eio objects.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.