package plebeia

  1. Overview
  2. Docs
package plebeia
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t = Fs.cursor -> (Fs.cursor * 'a, Error.t) result

Monad for synchronous file system operations

include Monad.S1 with type 'a t := 'a t
val return : 'a -> 'a t
val bind : 'a t -> ('a -> 'b t) -> 'b t
val map : ('a -> 'b) -> 'a t -> 'b t
val mapM : ('a -> 'b t) -> 'a list -> 'b list t
val mapM_ : ('a -> unit t) -> 'a list -> unit t
val iterM : ('a -> unit t) -> 'a list -> unit t

alias of mapM_

val fold_leftM : ('a -> 'b -> 'a t) -> 'a -> 'b list -> 'a t
val parseM : ('a -> 'b list -> ('a * 'b list) t) -> 'a -> 'b list -> 'a t
module Infix : sig ... end
module Syntax : sig ... end
val lift_result : ('a, Error.t) Result.t -> 'a t
val fail : Fs.error -> 'a t

Fail with the given error

val raw_cursor : Fs.raw_cursor t

Get the current underlying cursor

val chdir_parent : unit t

Moves the cursor up 1 directory level. If the cursor is already at the root, it does nothing.

val chdir_root : unit t

Moves the cursor up to the root directory. If the cursor is already at the root, it does nothing.

val chdir : ?dig:bool -> Fs_types.Path.t -> unit t

Moves the cursor to a sub-directory specified by the path. If dig=true, subdirectories are created if necessary.

val path : Fs_types.Path.t t

Get the current path of the cursor

File and directory access. It returns the current cursor and its view.

val set : Fs_types.Path.t -> Fs.cursor -> unit t

set path cursor sets the tree pointed by the cursor at the specified path.

The path must not be empty.

val copy : Fs_types.Path.t -> Fs_types.Path.t -> unit t

copy src dst sets the tree at src to dst. dst must not be empty.

Regular file read access.

val write : Fs_types.Path.t -> Value.t -> unit t

Create or update a regular file. Directories are created if necessary. The path must not be empty.

val rm : ?recursive:bool -> ?ignore_error:bool -> Fs_types.Path.t -> bool t

Remove a regular file or a directory, then returns Ok true. The path must not be empty.

recursive=false : fails when the target is a directory recursive=true : removes the target recursively if it is a directory ignore_error=false : fails when the target does not exist ignore_error=true : does not fail even if the target does not exist

Returns true if the target is really removed. Returns false if the target does not exist.

val rmdir : ?ignore_error:bool -> Fs_types.Path.t -> bool t

Recursive removal of a directory The path must not be empty.

ignore_error=false : fails when the target does not exist ignore_error=true : does not fail even if the target does not exist

Returns true if the target is really removed. Returns false if the target does not exist.

val compute_hash : Fs.hash t

Compute the Merkle hash of the cursor

val may_forget : unit t

Clear the memory cache of the tree under the current cursor, if it is already persisted on the disk.

val run : Fs.cursor -> 'a t -> (Fs.cursor * 'a, Error.t) result

Monad runner

val do_then : (Fs.cursor -> unit) -> 'a t -> 'a t

For debugging. do_then f op executes f against the current cursor, then performs op.