package plebeia

You can search for identifiers within the package.

in-package search v0.2.0

plebeia
- LICENSE
- README
- Library plebeia
  - Plebeia
    
    Internal
    
    Error
    
    Utils
    
    Exn
    
    Format
    
    String
    
    Hashtbl
    
    HashedType
    
    S
    
    Make
    
    SeededHashedType
    
    SeededS
    
    MakeSeeded
    
    List
    
    Open
    
    Option
    
    Op
    
    Result
    
    Monad
    
    S1
    
    Op
    
    Make1
    
    Op
    
    S2
    
    Op
    
    Make2
    
    Op
    
    Log
    
    Value
    
    Index
    
    Set
    
    Map
    
    Segment
    
    Context
    
    Node
    
    Node_tools
    
    Cursor
    
    Hash
    
    Node_hash
    
    Cursor_hash
    
    Lock
    
    Storage
    
    Chunk
    
    Node_storage
    
    Cursor_storage
    
    Hashcons
    
    Bud_cache
    
    Deep
    
    Roots
    
    Vc
    
    Stat
    
    Debug
    
    Traverse
    
    Diff
    
    Deep_stat
    
    Merkle_proof
    
    Cursor_tools
    
    GenTraverse
    
    Search
    
    Ediff
    
    Rand
    
    Gen
    
    Op
    
    RS
    
    Test_utils
    
    Exn
    
    Format
    
    String
    
    Hashtbl
    
    HashedType
    
    S
    
    Make
    
    SeededHashedType
    
    SeededS
    
    MakeSeeded
    
    List
    
    Open
    
    RS
    
    Error
    
    Result
    
    Op
    
    Value
    
    Segment
    
    Hash
    
    Hashcons
    
    Vc
    
    Roots
    
    RootHash
    
    Entry
    
    Stat
    
    Merkle_proof
- Sources
  - plebeia
    
    bud_cache.ml
    
    context.ml
    
    cursor.ml
    
    cursorM.ml
    
    cursor_hash.ml
    
    cursor_storage.ml
    
    cursor_tools.ml
    
    debug.ml
    
    deep.ml
    
    deep_stat.ml
    
    diff.ml
    
    ediff.ml
    
    error.ml
    
    gen.ml
    
    hash.ml
    
    hashcons.ml
    
    index.ml
    
    lock.ml
    
    log.ml
    
    merkle_proof.ml
    
    monad.ml
    
    node.ml
    
    node_hash.ml
    
    node_storage.ml
    
    node_tools.ml
    
    option.ml
    
    plebeia.ml
    
    plebeia__.ml
    
    plebeia_intf.ml
    
    rand.ml
    
    result.ml
    
    roots.ml
    
    search.ml
    
    segment.ml
    
    stat.ml
    
    storage.ml
    
    test_utils.ml
    
    traverse.ml
    
    utils.ml
    
    value.ml
    
    vc.ml
    
    xcstruct.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Internal.Deep`Source

3 High level

val deep : 
  go_up:bool ->
  create_subtrees:bool ->
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor ->
    Segment.t ->
    (Plebeia__.Cursor.cursor * 'a, Error.t) Result.t) ->
  (Plebeia__.Cursor.cursor * 'a, Error.t) Result.t

Multi Bud level interface. deep performs f against the node pointed by the multi segments.

Source

val get : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor
   * [ `Bud of Plebeia__.Node.view | `Leaf of Plebeia__.Node.view ],
    Error.t)
    Result.t

Source

val get_value : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor * Value.t, Error.t) Result.t

Source

val insert : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  Value.t ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Source

val upsert : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  Value.t ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Source

val update : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  Value.t ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Source

val delete : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

If the target does not exists, do nothing

Source

val delete_and_clean_empty : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

If the target does not exists, do nothing. If the result of the removal generates an empty bud, delete_and_clean_empty also cleans it.

The result cursor points to the bud which has the top most removed element.

Source

val create_subtree : 
  create_subtrees:bool ->
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Source

val subtree : 
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Source

val subtree_or_create : 
  create_subtrees:bool ->
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Source

val copy : 
  create_subtrees:bool ->
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

Subtree copy by making two nodes point to the same subtree.

Copy attempts which introduce loops are rejected.

Source

val link : 
  Plebeia__.Node.node ->
  Plebeia__.Cursor.cursor ->
  Segment.t list ->
  (Plebeia__.Cursor.cursor, Error.t) Result.t

link n c segs makes a link to n at c/segs.

link is like copy, but n needs not to be a part of the tree of c.

n and c must be of the same context. In addition, they must base on the same commit. Otherwise link can break the invariant of index ordering between commits used by the fast multi-commit node traversal Traverse.

There is no prevention of cycle creation.

package plebeia

Module Internal.DeepSource

Module `Internal.Deep`Source