package eio

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Reading files
Writing files
Directories
Other

package eio

eio
- Library eio
  - Eio
    
    Switch
    
    Promise
    
    Fiber
    
    List
    
    Semaphore
    
    Mutex
    
    Condition
    
    Stream
    
    Cancel
    
    Std
    
    Promise
    
    Fiber
    
    Switch
    
    Generic
    
    t
    
    Flow
    
    source
    
    sink
    
    two_way
    
    close
    
    Buf_read
    
    BE
    
    LE
    
    Syntax
    
    Buf_write
    
    BE
    
    LE
    
    Net
    
    Ipaddr
    
    V4
    
    V6
    
    Sockaddr
    
    socket
    
    stream_socket
    
    datagram_socket
    
    listening_socket
    
    t
    
    Process
    
    t
    
    mgr
    
    Domain_manager
    
    t
    
    Time
    
    clock_base
    
    clock
    
    Mono
    
    t
    
    Timeout
    
    File
    
    Unix_perm
    
    Stat
    
    ro
    
    rw
    
    Fs
    
    dir
    
    dir_with_close
    
    Path
    
    Debug
    
    Stdenv
    
    Exn
    
    Backend
    
    Private
    
    Ctf
    
    Control
    
    Cells
    
    CELL
    
    Make
    
    Broadcast
    
    Fiber_context
    
    Effects
    
    Suspend
    
    Waiters
    
    Debug
    
    Dla
- Library eio.mock
  - Eio_mock
    
    Action
    
    Handler
    
    Flow
    
    Net
    
    Clock
    
    S
    
    Mono
    
    Backend
- Library eio.unix
  - Eio_unix
    
    Fd
    
    Resource
    
    Net
    
    stream_socket
    
    datagram_socket
    
    t
    
    Ipaddr
    
    Process
    
    mgr
    
    Stdenv
    
    Private
    
    Rcfd
    
    Fork_action
    
    Ctf
- Library eio.utils
  - Eio_utils
    
    Lf_queue
    
    Suspended
    
    Ctf
    
    Zzz
    
    Key
- Sources
  - eio
    
    buf_read.ml
    
    buf_write.ml
    
    condition.ml
    
    domain_manager.ml
    
    eio.ml
    
    eio__.ml
    
    eio_mutex.ml
    
    file.ml
    
    flow.ml
    
    fs.ml
    
    generic.ml
    
    net.ml
    
    path.ml
    
    process.ml
    
    sem_state.ml
    
    semaphore.ml
    
    stream.ml
    
    sync.ml
    
    time.ml
  - eio.core
    
    broadcast.ml
    
    cancel.ml
    
    cells.ml
    
    ctf.ml
    
    debug.ml
    
    dla.ml
    
    eio__core.ml
    
    eio__core__.ml
    
    exn.ml
    
    fiber.ml
    
    hook.ml
    
    promise.ml
    
    single_waiter.ml
    
    suspend.ml
    
    switch.ml
    
    waiters.ml
  - eio.mock
    
    action.ml
    
    backend.ml
    
    clock.ml
    
    eio_mock.ml
    
    eio_mock__.ml
    
    flow.ml
    
    handler.ml
    
    net.ml
  - eio.unix
    
    ctf_unix.ml
    
    eio_unix.ml
    
    eio_unix__.ml
    
    fd.ml
    
    fork_action.ml
    
    inherit_fds.ml
    
    net.ml
    
    private.ml
    
    process.ml
    
    rcfd.ml
    
    resource.ml
    
    types.ml
  - eio.utils
    
    eio_utils.ml
    
    eio_utils__.ml
    
    lf_queue.ml
    
    suspended.ml
    
    zzz.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Eio.Path`Source

Accessing paths on a file-system.

A _ Path.t represents a particular location in some filesystem. It is a pair of a base directory and a relative path from there.

Eio.Stdenv.cwd provides access to the current working directory. For example:

  let ( / ) = Eio.Path.( / )

  let run dir =
    Eio.Path.save ~create:(`Exclusive 0o600)
      (dir / "output.txt") "the data"

  let () =
    Eio_main.run @@ fun env ->
    run (Eio.Stdenv.cwd env)

It is normally not permitted to access anything above the base directory, even by following a symlink. The exception is Stdenv.fs, which provides access to the whole file-system:

  Eio.Path.load (fs / "/etc/passwd")

Sourcetype 'a t = Fs.dir as 'a * Fs.path

An OS directory FD and a path relative to it, for use with e.g. openat(2).

Sourceval (/) : 'a t -> string -> 'a t

t / step is t with step appended to t's path, or replacing t's path if step is absolute:

(fd, "foo") / "bar" = (fd, "foo/bar")
(fd, "foo") / "/bar" = (fd, "/bar")

Sourceval pp : _ t Fmt.t

pp formats a _ t as "<label:path>", suitable for logging.

Reading files

Sourceval load : _ t -> string

load t returns the contents of the given file.

This is a convenience wrapper around with_open_in.

Sourceval open_in : sw:Switch.t -> _ t -> < File.ro ; Flow.close >

open_in ~sw t opens t for reading.

Note: files are always opened in binary mode.

Sourceval with_open_in : _ t -> (< File.ro ; Flow.close > -> 'a) -> 'a

with_open_in is like open_in, but calls fn flow with the new flow and closes it automatically when fn returns (if it hasn't already been closed by then).

Sourceval with_lines : _ t -> (string Seq.t -> 'a) -> 'a

with_lines t fn is a convenience function for streaming the lines of the file.

It uses Buf_read.lines.

Writing files

Sourceval save : ?append:bool -> create:Fs.create -> _ t -> string -> unit

save t data ~create writes data to t.

This is a convenience wrapper around with_open_out.

Source

val open_out : 
  sw:Switch.t ->
  ?append:bool ->
  create:Fs.create ->
  _ t ->
  < File.rw
  ; Flow.close >

open_out ~sw t opens t for reading and writing.

Note: files are always opened in binary mode.

parameter append
Open for appending: always write at end of file.

parameter create
Controls whether to create the file, and what permissions to give it if so.

Source

val with_open_out : 
  ?append:bool ->
  create:Fs.create ->
  _ t ->
  (< File.rw ; Flow.close > -> 'a) ->
  'a

with_open_out is like open_out, but calls fn flow with the new flow and closes it automatically when fn returns (if it hasn't already been closed by then).

Directories

Sourceval mkdir : perm:File.Unix_perm.t -> _ t -> unit

mkdir ~perm t creates a new directory t with permissions perm.

Sourceval open_dir : sw:Switch.t -> _ t -> < Fs.dir ; Flow.close > t

open_dir ~sw t opens t.

This can be passed to functions to grant access only to the subtree t.

Sourceval with_open_dir : _ t -> (< Fs.dir ; Flow.close > t -> 'a) -> 'a

with_open_dir is like open_dir, but calls fn dir with the new directory and closes it automatically when fn returns (if it hasn't already been closed by then).

Sourceval read_dir : _ t -> string list

read_dir t reads directory entries for t.

The entries are sorted using String.compare.

Note: The special Unix entries "." and ".." are not included in the results.

Other

Sourceval unlink : _ t -> unit

unlink t removes directory entry t.

Note: this cannot be used to unlink directories. Use rmdir for directories.

Sourceval rmdir : _ t -> unit

rmdir t removes directory entry t. This only works when the entry is itself a directory.

Note: this usually requires the directory to be empty.

Sourceval rename : _ t -> _ t -> unit

rename old_t new_t atomically unlinks old_t and links it as new_t.

If new_t already exists, it is atomically replaced.

package eio

Module Eio.PathSource

Reading files

Writing files

Directories

Other

Module `Eio.Path`Source