package plebeia

  1. Overview
  2. Docs
package plebeia
Legend:
Library
Module
Module type
Parameter
Class
Class type

File system over Plebeia tree.

Here, a `cursor` is a zipper over a Plebeia tree.

type name

Type of file name

module Path : Fs_intf.PATH with type name = name

Path name, a list of names

type raw_cursor

Type for the underlying cursor

type cursor

type for the pointer to a directory/file

type view

Type of Plebeia tree of a file or a directory

type hash

Hash of a file or a directory

type error =
  1. | Is_file of string * Path.t
  2. | Is_directory of string * Path.t
  3. | No_such_file_or_directory of string * Path.t
  4. | File_or_directory_exists of string * Path.t
  5. | Path_decode_failure of Segment.t
  6. | Other of string * string

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

type Error.t +=
  1. | FS_error of error
val make : raw_cursor -> Path.t -> cursor

make raw_cursor path wraps raw_cursor which points to path and returns a cursor

val empty : Context.t -> cursor

empty context returns a cursor pointing the empty file system

val context : cursor -> Context.t

Returns the underlying context of the given cursor

val get_raw_cursor : cursor -> raw_cursor

Get the underlying cursor

module Op : sig ... end
module Op_lwt : sig ... end
module Vc : sig ... end

Version control

module Merkle_proof : sig ... end