Enum TreeEdit 

pub enum TreeEdit {
    Identity,
    InsertNode {
        parent: u32,
        child_id: u32,
        node: Node,
        edge: Edge,
    },
    DeleteNode {
        id: u32,
    },
    ContractNode {
        id: u32,
    },
    RelabelNode {
        id: u32,
        new_anchor: Name,
    },
    SetField {
        node_id: u32,
        field: Name,
        value: Value,
    },
    RemoveField {
        node_id: u32,
        field: Name,
    },
    MoveSubtree {
        node_id: u32,
        new_parent: u32,
        edge: Edge,
    },
    InsertFan {
        fan: Fan,
    },
    DeleteFan {
        hyper_edge_id: Name,
    },
    JoinFeatures {
        primary: u32,
        joined: Vec<u32>,
        produce: Node,
    },
    Sequence(Vec<Self>),
}

A model of ThEditableStructure for W-type instances.

The edit monoid is free on these generators, quotiented by the equations apply(identity(), s) = s and apply(compose(e1, e2), s) = apply(e2, apply(e1, s)).

Variants

Identity

The monoid identity: no change.

InsertNode

Insert a new child node under an existing parent.

Fields

parent: u32

Parent node ID (must exist).

child_id: u32

ID for the new child node (must not already exist).

node: Node

The new node data.

edge: Edge

The edge connecting parent to child.

DeleteNode

Delete a leaf node (a node with no children).

Fields

id: u32

Node ID to delete.

ContractNode

Contract a non-leaf node: remove it and reattach its children to its parent.

Fields

id: u32

Node ID to contract.

RelabelNode

Change a node’s anchor vertex.

Fields

id: u32

Node ID to relabel.

new_anchor: Name

The new anchor vertex.

SetField

Set or update a field in a node’s extra_fields.

Fields

node_id: u32

Node ID.

field: Name

Field name.

value: Value

New value.

RemoveField

Remove a field from a node’s extra_fields.

Fields

node_id: u32

Node ID.

field: Name

Field name to remove.

MoveSubtree

Move a subtree to a new parent.

Fields

node_id: u32

Root of the subtree to move.

new_parent: u32

New parent node ID.

edge: Edge

Edge connecting new parent to the moved node.

InsertFan

Insert a new hyper-edge fan.

Fields

fan: Fan

The fan to insert.

DeleteFan

Delete a hyper-edge fan by its hyper-edge ID.

Fields

hyper_edge_id: Name

The hyper-edge ID of the fan to remove.

JoinFeatures

Merge multiple nodes into one via spatial join (co-located annotations merge into a single node).

Fields

primary: u32

The primary node that absorbs the others.

joined: Vec<u32>

Nodes to merge into the primary.

produce: Node

The resulting merged node data.

Sequence(Vec<Self>)

A sequence of edits applied in order.

Implementations

impl TreeEdit

pub const fn identity() -> Self

The monoid identity element.

pub fn compose(self, other: Self) -> Self

Monoid multiplication: compose two edits into a sequence.

Nested sequences are flattened and identity elements are elided.

pub fn is_identity(&self) -> bool

Returns true if this edit is the identity (no-op).

pub fn apply(&self, instance: &mut WInstance) -> Result<(), EditError>

Apply this edit to a W-type instance, mutating it in place.

This is the partial monoid action E × S → S. The action is partial because some edits fail on some states (e.g., deleting a nonexistent node).

Errors

Returns EditError if the edit cannot be applied to the current instance state.

Trait Implementations

impl Clone for TreeEdit

fn clone(&self) -> TreeEdit

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TreeEdit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TreeEdit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TreeEdit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.