package eio

  1. Overview
  2. Docs
package eio
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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.