Deep (p.plebeia.2.0.0.doc.plebeia.Plebeia.Deep)

Source

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

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

Source

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

Source

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

Source

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

Source

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

Source

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

Sourceval delete : Cursor.t -> Segment.t list -> (Cursor.t, Error.t) Result.t

If the target does not exists, do nothing

Sourceval delete' : Cursor.t -> Segment.t list -> (Cursor.t, Error.t) Result.t

Delete also internal and extender

Source

val delete_and_clean_empty : 
  Cursor.t ->
  Segment.t list ->
  (Cursor.t, 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 delete_and_clean_empty' : 
  Cursor.t ->
  Segment.t list ->
  (Cursor.t, 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 original position. If the Bud at the original position becomes empty, the funciton fails.

Source

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

Sourceval subtree : Cursor.t -> Segment.t list -> (Cursor.t, Error.t) Result.t

Source

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

Source

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

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

allow_overwrite is false by default

Source

val copy' : 
  ?allow_overwrite:bool ->
  ?only_bud:bool ->
  create_subtrees:bool ->
  copy_ref:Cursor.t ->
  Cursor.t ->
  Segment.t list ->
  Segment.t list ->
  (Cursor.t, Error.t) Result.t

General version of copy. Copiable non Buds if only_bud=true

allow_overwrite is false by default only_bud is false by default

Source

val link : 
  Node_type.node ->
  Cursor.t ->
  Segment.t list ->
  (Cursor.t, 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.

There is no prevention of cycle creation.

Source

val alter : 
  Cursor.t ->
  Segment.t list ->
  (Node_type.view option -> (Node_type.t, Error.t) result) ->
  (Cursor.t, Error.t) result