package irmin-fs

You can search for identifiers within the package.

in-package search v0.2.0

package irmin-fs

irmin-fs
- README_PPX
- Library irmin-fs
  - Irmin_fs
    
    IO
    
    Append_only
    
    Atomic_write
    
    Make
    
    Repo
    
    Status
    
    Head
    
    Hash
    
    Commit
    
    Contents
    
    Tree
    
    Contents
    
    History
    
    V
    
    E
    
    Branch
    
    Key
    
    Metadata
    
    Private
    
    Hash
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Path
    
    Key
    
    Metadata
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Val
    
    Node
    
    Path
    
    Key
    
    Metadata
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Branch
    
    Key
    
    Val
    
    Slice
    
    Repo
    
    Sync
    
    KV
    
    Repo
    
    Status
    
    Head
    
    Hash
    
    Commit
    
    Contents
    
    Tree
    
    Contents
    
    History
    
    V
    
    E
    
    Branch
    
    Key
    
    Metadata
    
    Private
    
    Hash
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Path
    
    Key
    
    Metadata
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Val
    
    Node
    
    Path
    
    Key
    
    Metadata
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Branch
    
    Key
    
    Val
    
    Slice
    
    Repo
    
    Sync
    
    Config
    
    Append_only_ext
    
    Atomic_write_ext
    
    Make_ext
    
    Repo
    
    Status
    
    Head
    
    Hash
    
    Commit
    
    Contents
    
    Tree
    
    Contents
    
    History
    
    V
    
    E
    
    Branch
    
    Key
    
    Metadata
    
    Private
    
    Hash
    
    Contents
    
    Key
    
    Val
    
    Node
    
    Path
    
    Key
    
    Metadata
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Commit
    
    Key
    
    Val
    
    Node
    
    Path
    
    Key
    
    Metadata
    
    Val
    
    Contents
    
    Key
    
    Val
    
    Branch
    
    Key
    
    Val
    
    Slice
    
    Repo
    
    Sync
    
    IO_mem
- Sources
  - irmin-fs
    
    import.ml
    
    irmin_fs.ml
    
    irmin_fs__.ml

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

Module `Irmin_fs.IO_mem`Source

include IO

File-system abstractions

Sourcetype path = string

The type for paths.

Read operations

Sourceval 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.

Sourceval file_exists : path -> bool Lwt.t

file_exist f is true if f exists.

Sourceval read_file : path -> string option Lwt.t

Read the contents of a file using mmap.

Write Operations

Sourceval mkdir : path -> unit Lwt.t

Create a directory.

Sourcetype lock

The type for file locks.

Sourceval lock_file : path -> lock

lock_file f is the lock associated to the file f.

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

Atomic writes.

Source

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

Test and set.

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

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

Sourceval clear : unit -> unit Lwt.t

Sourceval set_listen_hook : unit -> unit

package irmin-fs

Module Irmin_fs.IO_memSource

File-system abstractions

Read operations

Write Operations

Module `Irmin_fs.IO_mem`Source