Struct petgraph::dot::Dot

pub struct Dot<'a, G>where
    G: IntoEdgeReferences + IntoNodeReferences,{ /* private fields */ }

Dot implements output to graphviz .dot format for a graph.

Formatting and options are rather simple, this is mostly intended for debugging. Exact output may change.

Examples

use petgraph::Graph;
use petgraph::dot::{Dot, Config};

let mut graph = Graph::<_, ()>::new();
graph.add_node("A");
graph.add_node("B");
graph.add_node("C");
graph.add_node("D");
graph.extend_with_edges(&[
    (0, 1), (0, 2), (0, 3),
    (1, 2), (1, 3),
    (2, 3),
]);

println!("{:?}", Dot::with_config(&graph, &[Config::EdgeNoLabel]));

// In this case the output looks like this:
//
// digraph {
//     0 [label="\"A\""]
//     1 [label="\"B\""]
//     2 [label="\"C\""]
//     3 [label="\"D\""]
//     0 -> 1
//     0 -> 2
//     0 -> 3
//     1 -> 2
//     1 -> 3
//     2 -> 3
// }

// If you need multiple config options, just list them all in the slice.

Implementations

impl<'a, G> Dot<'a, G>where
    G: IntoNodeReferences + IntoEdgeReferences,

pub fn new(graph: G) -> Self

Create a Dot formatting wrapper with default configuration.

pub fn with_config(graph: G, config: &'a [Config]) -> Self

Create a Dot formatting wrapper with custom configuration.

pub fn with_attr_getters(
    graph: G,
    config: &'a [Config],
    get_edge_attributes: &'a dyn Fn(G, G::EdgeRef) -> String,
    get_node_attributes: &'a dyn Fn(G, G::NodeRef) -> String
) -> Self

Trait Implementations

impl<'a, G> Debug for Dot<'a, G>where
    G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp,
    G::EdgeWeight: Debug,
    G::NodeWeight: Debug,

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

Formats the value using the given formatter.

impl<'a, G> Display for Dot<'a, G>where
    G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp,
    G::EdgeWeight: Display,
    G::NodeWeight: Display,

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

Formats the value using the given formatter.