Skip to main content

Module model

Module model 

Source
Expand description

Graph domain model: nodes, edges, and validity/brokenness findings.

Structs§

Broken
target is a req id or a link-target path.
Edge
Graph
Invalid
Node
NodeKey

Enums§

EdgeKind
NodeKind
ReasonCode
TargetKind

Functions§

desc_edge_id
"desc:doc:<id>" for a Doc node, "desc:req:<id>" for a Req node. The node kind is part of the id because a Doc and a Req may share an id. Test nodes never have a desc edge.
edge_hashes
The (from, to) hashes recorded in the lock for edge. DocReq / TestReq use the hashes of both endpoint nodes (empty if the node is missing); Desc uses (hash of the description, hash of the body) of the from node. Every edge in graph.edges has its nodes, so the missing-node results are unreachable in practice.
edge_id
"doc-req:<from>:<to>" / "test-req:<from>:<to>". Desc edges have a different shape; use desc_edge_id for them.
is_valid_id
id is non-empty and contains only [A-Za-z0-9._-].