Struct dot_writer::Scope

pub struct Scope<'d, 'w> { /* fields omitted */ }

A Scope struct represents either a graph, digraph, subgraph or cluster. Its the workhorse of the DOT writing, and can be used to create new sub-scopes, add nodes, add edges, or adjust default attributes for any of the above.

The only way to construct a top level graph or digraph scope is to call the DotWriter::graph or DotWriter::digraph functions on a new DotWriter.

Implementations

impl<'d, 'w> Scope<'d, 'w>

pub fn subgraph(&mut self) -> Scope<'_, 'w>

Starts a new nested subgraph, returning another Scope for writing to that subgraph.

pub fn cluster(&mut self) -> Scope<'_, 'w>

Starts a new nested cluster subgraph, returning another Scope for writing to it. A cluster is a special case of a subgraph which groups its child nodes together. See the “Subgraphs and Clusters” section of the Graphviz documentation for more information.

pub fn graph_attributes(&mut self) -> AttributesList<'_, 'w>

pub fn edge_attributes(&mut self) -> AttributesList<'_, 'w>

pub fn node_attributes(&mut self) -> AttributesList<'_, 'w>

pub fn node_auto(&mut self) -> Node<'_, 'w>

Creates a new node, with an automatic default id of the format node_x where x is an incerementing integer. You don’t have to declare nodes before using them in a call to Scope::edge, but you do have to declare them using this function if you want to set specifc attributes for this node (font etc).

The returned value can be used to get the automatically generated id, and also to set the attributes.

pub fn node_named<S: Into<String>>(&mut self, id: S) -> Node<'_, 'w>

Creates a new node, with the specified id. You don’t have to declare nodes before using them in a call to Scope::edge, but you do have to declare them using this function if you want to set specific attributes for this node (font etc).

The returned value can be used to get the assigned name, and also to set the attributes.

pub fn edge<S, E>(
    &mut self,
    start_node_id: S,
    end_node_id: E
) -> EdgeList<'_, 'w> where
    S: AsRef<[u8]>,
    E: AsRef<[u8]>, 

Add a new edge joining start_node_id and end_node_id nodes. Note that nodes do not need to be already defined by Scope::node_auto or by Scope::node_named (unless you want to set node-specific attributes). Arguments can be just strings, or you can use the Node::id of an already defined node:

use dot_writer::DotWriter;

let mut output_bytes = Vec::new();
{
  let mut writer = DotWriter::from(&mut output_bytes);
  writer.set_pretty_print(false);
  let mut digraph = writer.digraph();
  let a = digraph.node_auto().id();
  digraph.edge(a, "b");
}
assert_eq!(
    std::str::from_utf8(&output_bytes).unwrap(),
    "digraph{node_0;node_0->b;}"
);

pub fn edges<I, E>(&mut self, items: I) -> Option<EdgeList<'_, 'w>> where
    I: IntoIterator<Item = E>,
    E: AsRef<[u8]>, 

Add N-1 edges joining all node ids or subgraphs in the iterator, in the same manner as Scope::edge. The return value will be None if less than 2 items are passed in.

use dot_writer::DotWriter;

let mut output_bytes = Vec::new();
{
  let mut writer = DotWriter::from(&mut output_bytes);
  writer.set_pretty_print(false);
  let mut digraph = writer.digraph();
  digraph.edges(["a", "b", "c"]);
}
assert_eq!(
    std::str::from_utf8(&output_bytes).unwrap(),
    "digraph{a->b->c;}"
);

Trait Implementations

impl<'d, 'w> Attributes for Scope<'d, 'w>

fn set(&mut self, name: &str, value: &str, quote: bool) -> &mut Self

Sets an attribute. See the Graphviz documentation for a full list of available names and values. Set the arguement quote to true if the value should be written in quotes ", to escape any special characters. Not that any quote in the string need to be escaped before calling.

fn set_font(&mut self, label: &str) -> &mut Self

fn set_html(&mut self, label: &str) -> &mut Self

Set arbitary html, useful for constructing more complex nodes

fn set_label(&mut self, label: &str) -> &mut Self

Set the display label for a graph, node or edge

fn set_head_label(&mut self, label: &str) -> &mut Self

Set the label to appear at the head of an edge

fn set_tail_label(&mut self, label: &str) -> &mut Self

Set the label to appear at the tail of an edge

fn set_color(&mut self, color: Color) -> &mut Self

Set the edge or line color

fn set_fill_color(&mut self, color: Color) -> &mut Self

Set the color to fill the are with

fn set_font_color(&mut self, color: Color) -> &mut Self

Set the color of the font

fn set_background_color(&mut self, color: Color) -> &mut Self

Set the background color

fn set_shape(&mut self, shape: Shape) -> &mut Self

Set the shape of a graph, subgraph, cluster or node

fn set_style(&mut self, style: Style) -> &mut Self

Set the style

fn set_arrow_head(&mut self, arrow_type: ArrowType) -> &mut Self

Set type of arrow head for edge lines

fn set_arrow_tail(&mut self, arrow_type: ArrowType) -> &mut Self

Set type of arrow tail for edge lines

fn set_rank(&mut self, rank: Rank) -> &mut Self

Set the relative rank

fn set_pen_width(&mut self, width: f32) -> &mut Self

Set the pen width for drawing lines

fn set_arrow_size(&mut self, size: f32) -> &mut Self

Set the arrow size

fn set_font_size(&mut self, size: f32) -> &mut Self

Set the font size

fn set_rank_direction(&mut self, rank_direction: RankDirection) -> &mut Self

impl<'d, 'w> Drop for Scope<'d, 'w>

fn drop(&mut self)

Executes the destructor for this type.