package plebeia

  1. Overview
  2. Docs

Module Plebeia.Fs_treeSource

File system over Plebeia tree, with a "tree" interface.

Here, a `tree` is a subtree of Plebeia tree. This is different from the `cursor` of `Fs` which is a zipper pointer to a tree.

Accesses to the tree items are by the absolute path names from the root of the tree. Fs_tree optimizes contiguous file accesses in the same directories using zipper internally.

File system via Plebeia

Type of file name

Sourcemodule Name = Fs_types.Name
Sourcemodule Path = Fs_types.Path

Path name, a list of names

Sourcemodule FsError = Fs_types.FsError
Sourcetype raw_cursor = Cursor.t

Type for the underlying cursor

Sourcetype tree

Type of Plebeia tree of a file or a directory

Type for the contents of a file or a directory

Hash of a file or a directory

Sourcetype error = FsError.t

Errors. The first parameter is the name of the failed API function

make raw_tree path wraps raw_tree which points to path and returns a tree

empty context returns a tree pointing the empty file system

Sourceval context : tree -> Context.t

Returns the underlying context of the given tree

Sourceval get_raw_cursor : tree -> raw_cursor

Get the underlying raw cursor

Sourceval index : tree -> Index.t option
Sourceval forget_info : tree -> tree
Sourceval top_tree : tree -> tree
Sourceval compute_hash : tree -> tree * Hash.t
Sourceval write_top_tree : tree -> (tree * (Index.t * hash), Error.t) result
Sourceval may_forget : tree -> tree
Sourcemodule Op : sig ... end
Sourcemodule Op_lwt : sig ... end
Sourcemodule Vc : sig ... end

Version control

Sourcemodule Merkle_proof : sig ... end