ucp-graph 0.1.15

Generic graph runtime, stores, and traversal APIs for UCP documents
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

use serde::{Deserialize, Serialize};
use ucm_core::BlockId;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum GraphDetailLevel {
    Stub,
    #[default]
    Summary,
    Full,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphNodeSummary {
    pub block_id: BlockId,
    pub label: String,
    pub content_type: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub semantic_role: Option<String>,
    #[serde(default)]
    pub tags: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parent: Option<BlockId>,
    pub children: usize,
    pub outgoing_edges: usize,
    pub incoming_edges: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphEdgeSummary {
    pub source: BlockId,
    pub target: BlockId,
    pub relation: String,
    pub direction: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphPathHop {
    pub from: BlockId,
    pub to: BlockId,
    pub relation: String,
    pub direction: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphPathResult {
    pub start: GraphNodeSummary,
    pub end: GraphNodeSummary,
    #[serde(default)]
    pub hops: Vec<GraphPathHop>,
}