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

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.5.tbz
sha256=7d70d1f5fb2b7190bf1ab28fffeb272da51ffe6d6c9c7c94e0485fabdf3b3fda
sha512=4582ac2fb2f8616b3d8ae9670eb7913a78085899b14044408801b30a34fed6c4d32971ba72eedb0cbc3d82c057610cf81c482090e75e2985330fcde96478ac5e

doc/eio/Eio/Fs/index.html

Module Eio.FsSource

File-system types.

Note: file-system operations, such as opening or deleting files, can be found in the Path module.

Types

Sourcetype path = string
Sourcetype error =
  1. | Already_exists of Exn.Backend.t
  2. | Not_found of Exn.Backend.t
  3. | Permission_denied of Exn.Backend.t
  4. | File_too_large
  5. | Not_native of string
    (*

    Raised by Path.native_exn.

    *)
Sourcetype Exn.err +=
  1. | E of error
Sourceval err : error -> exn
Sourcetype create = [
  1. | `Never
    (*

    fail if the named file doesn't exist

    *)
  2. | `If_missing of File.Unix_perm.t
    (*

    create if file doesn't already exist

    *)
  3. | `Or_truncate of File.Unix_perm.t
    (*

    any existing file is truncated to zero length

    *)
  4. | `Exclusive of File.Unix_perm.t
    (*

    always create; fail if the file already exists

    *)
]

When to create a new file.

If a new file is created, the given permissions are used for it.

Sourcetype dir_ty = [
  1. | `Dir
]
Sourcetype -'a dir = ([> dir_ty ] as 'a) Std.r

Note: use the functions in Path to access directories.

Provider Interface

Sourcemodule Pi : sig ... end