package plebeia

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

Module Fs.MakeSource

File system via Plebeia

Parameters

Signature

Sourcetype name = Name.t

Type of file name

Sourcemodule Path : Fs_intf.PATH with type name = name

Path name, a list of names

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

Sourcetype 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

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

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

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

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