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 (22)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.6.tbz
sha256=c1f04986b401094176494863dde1ca9b292b59fdc679a9d7023e558d80fb5b15
sha512=92ed8cf20300b8a4e0141bdbc373c0803c5a24530cb65852637d905fff4a5b956a8859a00a424034ff78c1112da9b0391194bcd558326168bdebd1ce683a8890

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

Module Eio_unix.FileSource

Extended file API with support for file descriptors.

  • since 1.6
Sourcetype rw_ty = [
  1. | `Unix_fd
  2. | Eio.File.rw_ty
]
Sourcetype ro_ty = [
  1. | `Unix_fd
  2. | Eio.File.ro_ty
]
Sourceval import_rw : sw:Eio.Std.Switch.t -> close_unix:bool -> Unix.file_descr -> [< rw_ty ] Eio.Std.r

import_rw ~sw ~close_unix fd is a read/write Eio file that uses fd.

The file resource will be closed when sw finishes.

The backend takes ownership of fd and may change whether it is non-blocking.

The close_unix and sw arguments are passed to Fd.of_unix.

Sourceval import_ro : sw:Eio.Std.Switch.t -> close_unix:bool -> Unix.file_descr -> [< ro_ty ] Eio.Std.r

import_ro is like import_rw, but casts the result to be read-only.