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.

File system via Plebeia

module Name = Fs_types.Name
type name = Name.t

Type of file name

module Path = Fs_types.Path

Path name, a list of names

module FsError = Fs_types.FsError
type error = FsError.t

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

type raw_cursor = Cursor.t

Type for the underlying cursor

type cursor

type for the pointer to a directory/file

type view = Node_type.view

Type of Plebeia tree of a file or a directory

type hash = Hash.Prefix.t

Hash of a file or a directory

val make : raw_cursor -> Fs_nameenc.t -> Path.t -> cursor

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

val empty : Context.t -> Fs_nameenc.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

val index : cursor -> Index.t option
val forget_info : cursor -> cursor
val top_cursor : cursor -> cursor
val compute_hash : cursor -> cursor * Hash.t
val write_top_cursor : cursor -> (cursor * (Index.t * hash), Error.t) result
val may_forget : cursor -> cursor
module Op : sig ... end
module Op_lwt : sig ... end
module Vc : sig ... end

Version control

module Merkle_proof : sig ... end