Trait Labeller

Source

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

    // Provided methods
    fn graph_attrs(&'a self) -> HashMap<&str, &str> { ... }
    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 node_attrs(&'a self, _n: &N) -> HashMap<&str, &str> { ... }
    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 edge_attrs(&'a self, _e: &E) -> HashMap<&str, &str> { ... }
    fn kind(&self) -> Kind { ... }
    fn edge_start_point(&'a self, _e: &E) -> Option<CompassPoint> { ... }
    fn edge_end_point(&'a self, _e: &E) -> Option<CompassPoint> { ... }
    fn edge_start_port(&'a self, _: &E) -> Option<Id<'a>> { ... }
    fn edge_end_port(&'a self, _: &E) -> Option<Id<'a>> { ... }
}

Expand description

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§

Source

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

Must return a DOT compatible identifier naming the graph.

Source

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§

Source

fn graph_attrs(&'a self) -> HashMap<&str, &str>

A list of attributes to apply to the graph

Source

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.

Source

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.

Source

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.

Source