Struct Graph 

pub struct Graph {
    pub nodes: Vec<Node>,
    pub edges: Vec<Edge>,
    /* private fields */
}

The typed, bidirectional document multigraph.

Fields

nodes: Vec<Node>

Nodes in input (document discovery) order.

edges: Vec<Edge>

Edges in declaration order.

Implementations

impl Graph

pub fn build(docs: &[&StrayMarkDocument]) -> Graph

Build the graph from parsed documents. Never drops a node or an edge: orphan documents become isolated nodes; references to ids absent from the corpus become resolved: false edges.

pub fn node(&self, id: &str) -> Option<&Node>

Node lookup by id.

pub fn out_edges(&self, id: &str) -> impl Iterator<Item = &Edge>

Outgoing edges of a node, in declaration order.

pub fn in_edges(&self, id: &str) -> impl Iterator<Item = &Edge>

Incoming (resolved) edges of a node.

pub fn orphans(&self) -> impl Iterator<Item = &Node>

Documents with no links in either direction, in input order.

pub fn dangling_edges(&self) -> impl Iterator<Item = &Edge>

Edges whose target id is absent from the corpus, in declaration order.

Trait Implementations

impl Debug for Graph

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

Formats the value using the given formatter.

impl Default for Graph

fn default() -> Graph

Returns the “default value” for a type.