package plebeia

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

Module Plebeia.FsSource

File system over Plebeia tree.

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

File system via Plebeia

Sourcemodule Name = Fs_types.Name
Sourcetype name = Name.t

Type of file name

Sourcemodule Path = Fs_types.Path

Path name, a list of names

Sourcemodule FsError = Fs_types.FsError
Sourcetype error = FsError.t

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

Sourcetype raw_cursor = Cursor.t

Type for the underlying cursor

Sourcetype cursor

type for the pointer to a directory/file

Type of Plebeia tree of a file or a directory

Hash of a file or a directory

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

empty context returns a cursor pointing the empty file system

Sourceval context : cursor -> Context.t

Returns the underlying context of the given cursor

Sourceval get_raw_cursor : cursor -> raw_cursor

Get the underlying cursor

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

Version control

Sourcemodule Merkle_proof : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct