package plebeia

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

File system via Plebeia

Parameters

Signature

type name = Name.t

Type of file name

module Path : Fs_tree.PATH with type name = name

Path name, a list of names

type raw_cursor = Cursor.t

Type for the underlying cursor

type tree

Type of Plebeia tree of a file or a directory

Type for the cursor based file system module, Fs

type view = Node_type.view

Type for the contents of a file or a directory

type hash = Hash.Prefix.t

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 -> tree

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

val empty : Context.t -> tree

empty context returns a tree pointing the empty file system

val context : tree -> Context.t

Returns the underlying context of the given tree

val get_raw_cursor : tree -> raw_cursor

Get the underlying raw cursor

val of_cursor : cursor -> tree

Conversions between cursor for `Fs` module

val to_cursor : tree -> cursor
module Op : sig ... end
module Op_lwt : sig ... end
module Vc : sig ... end

Version control

module Merkle_proof : sig ... end