dot_graph

A library for generating Graphviz DOT language files. The code is forked from dot-rust with new API for easier to use.

Usage

The very basic three parts of a DOT file and in this library is Graph, Node and Edge. Graph is the entry point of the library. You could generate an empty graph .dot file by simply use:

```rust use dot_graph::{Graph, Kind};

let graph = Graph::new("empty_graph", Kind::Digraph);

let dotstring = graph.todot_string().unwrap();

asserteq!(dotstring, r#"digraph empty_graph { } //!"#); ```

In order to add some basic nodes and edges:

```rust use dot_graph::{Graph, Kind, Node, Edge};

let mut graph = Graph::new("single_edge", Kind::Digraph);

graph.addnode(Node::new("N0")); graph.addnode(Node::new("N1")); graph.add_edge(Edge::new("N0", "N1", "E"));

let dotstring = graph.todot_string().unwrap();

asserteq!(dotstring, r#"digraph single_edge { N0[label="N0"]; N1[label="N1"]; N0 -> N1[label="E"]; } "#); ```

If you want add some more attributes, like style, arrow, color, you could call these methods in a chain, like:

```rust use dot_graph::{Graph, Kind, Node, Edge, Style};

let mut graph = Graph::new("single_edge", Kind::Digraph);

graph.addnode(Node::new("N0")); graph.addnode(Node::new("N1")); graph.add_edge(Edge::new("N0", "N1", "E").style(Style::Bold).color(Some("red")));

asserteq!(graph.todotstring().unwrap(), r#"digraph singleedge { N0[label="N0"]; N1[label="N1"]; N0 -> N1[label="E"][style="bold"][color="red"]; } "#); ```

After version 0.2.1, dot_graph support subgraph generation, for example:

```rust

[test]

fn testsubgraph() { let mut graph = Graph::new("di", Kind::Digraph); let mut c1 = Subgraph::new("cluster0").label(""); c1.addnode(Node::new("N0")); c1.addnode(Node::new("N1")); let mut c2 = Subgraph::new("cluster1").label(""); c2.addnode(Node::new("N2")); c2.addnode(Node::new("N3")); graph.addsubgraph(c1); graph.addsubgraph(c2); graph.addedge(Edge::new("N0", "N1", "")); graph.addedge(Edge::new("N0", "N2", "")); graph.addedge(Edge::new("N1", "N3", "")); graph.add_edge(Edge::new("N2", "N3", ""));

assert_eq!(graph.to_dot_string().unwrap(),

r#"digraph di { subgraph cluster0 { label=""; N0[label="N0"]; N1[label="N1"]; } subgraph cluster1 { label=""; N2[label="N2"]; N3[label="N3"]; } N0 -> N1[label=""]; N0 -> N2[label=""]; N1 -> N3[label=""]; N2 -> N3[label=""]; } "#); } ```

For more examples, please check the tests.

The library is under active development, we'll include more dot attributes in the future.

Roadmap (TODO list)

• support for subgraph

Contributing

• All sorts of contributing are welcome. create issue and/or PR as you please.
• We belive that TDD(Test-Driven Development) approach is helpful not only in development, but also in communication with each other. So adding more tests might be a good way to report a bug or even suggest a new feature.

License

dot_graph is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Related Project

rudg: Rust UML Diagram Generator. A library for generating UML diagram from Rust source code.