Trait dot::Labeller

pub trait Labeller<'a, N, E> {
    // Required methods
    fn graph_id(&'a self) -> Id<'a>;
    fn node_id(&'a self, n: &N) -> Id<'a>;

    // Provided methods
    fn node_shape(&'a self, _node: &N) -> Option<LabelText<'a>> { ... }
    fn node_label(&'a self, n: &N) -> LabelText<'a> { ... }
    fn edge_label(&'a self, e: &E) -> LabelText<'a> { ... }
    fn node_style(&'a self, _n: &N) -> Style { ... }
    fn rank_dir(&'a self) -> Option<RankDir> { ... }
    fn node_color(&'a self, _node: &N) -> Option<LabelText<'a>> { ... }
    fn edge_end_arrow(&'a self, _e: &E) -> Arrow { ... }
    fn edge_start_arrow(&'a self, _e: &E) -> Arrow { ... }
    fn edge_style(&'a self, _e: &E) -> Style { ... }
    fn edge_color(&'a self, _e: &E) -> Option<LabelText<'a>> { ... }
    fn kind(&self) -> Kind { ... }
    fn source_port_position(
        &'a self,
        _e: &E
    ) -> (Option<Id<'a>>, Option<CompassPoint>) { ... }
    fn target_port_position(
        &'a self,
        _e: &E
    ) -> (Option<Id<'a>>, Option<CompassPoint>) { ... }
}

Each instance of a type that implements Label<C> maps to a unique identifier with respect to C, which is used to identify it in the generated .dot file. They can also provide more elaborate (and non-unique) label text that is used in the graphviz rendered output. The graph instance is responsible for providing the DOT compatible identifiers for the nodes and (optionally) rendered labels for the nodes and edges, as well as an identifier for the graph itself.

Required Methods

fn graph_id(&'a self) -> Id<'a>

Must return a DOT compatible identifier naming the graph.

fn node_id(&'a self, n: &N) -> Id<'a>

Maps n to a unique identifier with respect to self. The implementer is responsible for ensuring that the returned name is a valid DOT identifier.

Provided Methods

fn node_shape(&'a self, _node: &N) -> Option<LabelText<'a>>

Maps n to one of the graphviz shape names. If None is returned, no shape attribute is specified.

fn node_label(&'a self, n: &N) -> LabelText<'a>

Maps n to a label that will be used in the rendered output. The label need not be unique, and may be the empty string; the default is just the output from node_id.

fn edge_label(&'a self, e: &E) -> LabelText<'a>

Maps e to a label that will be used in the rendered output. The label need not be unique, and may be the empty string; the default is in fact the empty string.

fn node_style(&'a self, _n: &N) -> Style

Maps n to a style that will be used in the rendered output.

fn rank_dir(&'a self) -> Option<RankDir>

Return an explicit rank dir to use for directed graphs.

Return ‘None’ to use the default (generally “TB” for directed graphs).

fn node_color(&'a self, _node: &N) -> Option<LabelText<'a>>

Maps n to one of the graphviz color names. If None is returned, no color attribute is specified.

fn edge_end_arrow(&'a self, _e: &E) -> Arrow

Maps e to arrow style that will be used on the end of an edge. Defaults to default arrow style.

fn edge_start_arrow(&'a self, _e: &E) -> Arrow

Maps e to arrow style that will be used on the end of an edge. Defaults to default arrow style.

fn edge_style(&'a self, _e: &E) -> Style

Maps e to a style that will be used in the rendered output.

fn edge_color(&'a self, _e: &E) -> Option<LabelText<'a>>

Maps e to one of the graphviz color names. If None is returned, no color attribute is specified.

fn kind(&self) -> Kind

The kind of graph, defaults to Kind::Digraph.

fn source_port_position( &'a self, _e: &E ) -> (Option<Id<'a>>, Option<CompassPoint>)

Specify a subpart of the source node for the origin of the edge (portname) and a direction for the edge (compass_point). See also https://graphviz.org/docs/attr-types/portPos/.

For the portname to take effect the node shape must be record. See also https://graphviz.org/doc/info/shapes.html#record

fn target_port_position( &'a self, _e: &E ) -> (Option<Id<'a>>, Option<CompassPoint>)

Same as source_port_position but for the target end of the edge.

Implementors