package plebeia

You can search for identifiers within the package.

in-package search v0.2.0

package plebeia

plebeia
- Plebeia
  - Commit
  - Commit_db
  - Commit_hash
  - Commit_tree
    
    Internal
    
    Node
    
    View
  - Context
  - Copy
  - Cursor
    
    Cursor_storage
    
    Internal
    
    Monad
    
    Infix
    
    Syntax
  - Cursor_stat
  - Cursor_tools
    
    GenTraverse
  - Data_encoding_tools
  - Debug
  - Deep
  - Diff
  - Error
  - Fs
    
    Merkle_proof
    
    Op
    
    Infix
    
    Syntax
    
    Op_lwt
    
    Infix
    
    Syntax
    
    Vc
  - Fs_impl
    
    Merkle_proof
    
    Op
    
    Loose
    
    Monad
    
    Infix
    
    Syntax
    
    Op_lwt
    
    Monad
    
    Infix
    
    Syntax
    
    Vc
  - Fs_nameenc
  - Fs_nameenc_impl
    
    Bits6
    
    Bits8
    
    Compressed
    
    Arg
    
    B
    
    Record
    
    Lock
    
    Test
    
    Compressed'
    
    Compressed''
  - Fs_tree
    
    Merkle_proof
    
    Op
    
    Infix
    
    Syntax
    
    Op_lwt
    
    Infix
    
    Syntax
    
    Vc
  - Fs_types
    
    FsError
    
    NAMEENC
    
    Name
    
    Path
  - Gen
    
    Infix
    
    Syntax
  - Hash
    
    Hasher
    
    Prefix
  - Hashcons
  - Hashfunc
    
    Blake2B
    
    A
    
    Blake3
    
    A
  - Index
    
    Unsafe
  - Info
  - Internal
  - Key
  - Limit
  - Lock
  - Log
  - Merkle_proof
    
    Tree
  - Mmap
    
    Arch64
    
    Buffer
    
    Buffer
  - Monad
    
    Make1
    
    A
    
    Infix
    
    Syntax
    
    Make2
    
    A
    
    Infix
    
    Syntax
    
    S1
    
    Infix
    
    Syntax
    
    S2
    
    Infix
    
    Syntax
  - Node
  - Node_cache
  - Node_hash
  - Node_offsets
  - Node_storage
    
    Internal
  - Node_tools
  - Node_type
    
    Fold
    
    Fold'
    
    Mapper
  - Option
    
    Infix
    
    Syntax
  - Path
  - Result
    
    Infix
    
    Syntax
  - Result_lwt
    
    Infix
    
    Syntax
  - Segment
    
    Segs
    
    Serialization
    
    StringEnc
  - Segment_int_array
    
    Bits
    
    Type
    
    Int63
    
    Internal
    
    Segs
    
    Serialization
    
    StringEnc
    
    Vector
  - Snapshot
    
    Internal
    
    Elem
    
    Stat
  - Stat
  - Storage
    
    Chunk
    
    Internal
    
    Header
    
    Stat
  - Traverse
    
    Iter
    
    Map
  - Utils
    
    Array
    
    Syntax
    
    Exn
    
    Format
    
    Int
    
    List
    
    Open
    
    Int
    
    String
  - Value
  - Vc
  - Xcstruct
plebeia.msync
- Plebeia_msync
  - Msync
    
    Lwt
plebeia.test_utils
- Test_utils
  - Do_random
    
    Deep
    
    Flat
    
    Vc
  - Dumb
  - Fs_simulation
    
    Simulation
    
    Context
    
    Map
    
    Op
    
    Infix
    
    Syntax
    
    Op_lwt
    
    Infix
    
    Syntax
    
    WithSimulation
    
    Op
    
    Monad
    
    Infix
    
    Syntax
    
    Op_lwt
    
    Infix
    
    Syntax
  - SegmentListSet
  - SegmentSet

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = Merkle_proof.t

type detail = Fs_types.Path.t * Segment.segment list * Node_type.node option

val encoding : Fs_tree.Vc.t -> t Data_encoding.t

val pp : Stdlib.Format.formatter -> t -> unit

val make : 
  Fs_types.Path.t ->
  Fs_types.Path.t list ->
  (t * detail list) Fs_tree.Op.t

make basedir paths builds a Merkle proof of the paths from basedir. It also returns the objects at paths.

val check : 
  Fs_tree.Vc.t ->
  t ->
  (Hash.Prefix.t * detail list, Error.t) Stdlib.result

Compute the top hash of the given Merkle proof. It also returns the objects at the paths attached with the proof.