package irmin-fs

You can search for identifiers within the package.

in-package search v0.2.0

Generic file-system backend for Irmin

Install

Dune Dependency

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

Authors

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-2.9.1.tbz

sha256=16003a8a873737b0a8ae2a940399b14754c5c2ba506e4511b96df4473e912783

sha512=64682e67c1e9f6b6f6a5f017da7c0d7e5316e2dd139ad8ad7ad43b73003d827fb9f3141c10469986dee47849687c841a297b91d08186f72268c41e026810a647

doc/irmin-fs/Irmin_fs/Make_ext/argument-1-IO/index.html

Parameter `Make_ext.IO`

File-system abstractions

type path = string

The type for paths.

Read operations

val rec_files : path -> string list Lwt.t

rec_files dir is the list of files recursively present in dir and all of its sub-directories. Return filenames prefixed by dir.

val file_exists : path -> bool Lwt.t

file_exist f is true if f exists.

val read_file : path -> string option Lwt.t

Read the contents of a file using mmap.

Write Operations

val mkdir : path -> unit Lwt.t

Create a directory.

type lock

The type for file locks.

val lock_file : path -> lock

lock_file f is the lock associated to the file f.

val write_file : ?temp_dir:path -> ?lock:lock -> path -> string -> unit Lwt.t

Atomic writes.

val test_and_set_file : 
  ?temp_dir:string ->
  lock:lock ->
  path ->
  test:string option ->
  set:string option ->
  bool Lwt.t

Test and set.

val remove_file : ?lock:lock -> path -> unit Lwt.t

Remove a file or directory (even if non-empty).

On This Page

File-system abstractions
1. Read operations
2. Write Operations