pub struct Dot<'a, G> where
G: IntoEdgeReferences + IntoNodeReferences, { /* private fields */ }
Expand description
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
sourceimpl<'a, G> Dot<'a, G> where
G: IntoNodeReferences + IntoEdgeReferences,
impl<'a, G> Dot<'a, G> where
G: IntoNodeReferences + IntoEdgeReferences,
sourcepub fn with_config(graph: G, config: &'a [Config]) -> Dot<'a, G>
pub fn with_config(graph: G, config: &'a [Config]) -> Dot<'a, G>
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 as IntoEdgeReferences>::EdgeRef) + 'a),
get_node_attributes: &'a (dyn Fn(G, <G as IntoNodeReferences>::NodeRef) + 'a)
) -> Dot<'a, G>
Trait Implementations
sourceimpl<'a, G> Debug for Dot<'a, G> where
G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp,
<G as Data>::EdgeWeight: Debug,
<G as Data>::NodeWeight: Debug,
impl<'a, G> Debug for Dot<'a, G> where
G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp,
<G as Data>::EdgeWeight: Debug,
<G as Data>::NodeWeight: Debug,
sourceimpl<'a, G> Display for Dot<'a, G> where
G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp,
<G as Data>::EdgeWeight: Display,
<G as Data>::NodeWeight: Display,
impl<'a, G> Display for Dot<'a, G> where
G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp,
<G as Data>::EdgeWeight: Display,
<G as Data>::NodeWeight: Display,
Auto Trait Implementations
impl<'a, G> !RefUnwindSafe for Dot<'a, G>
impl<'a, G> !Send for Dot<'a, G>
impl<'a, G> !Sync for Dot<'a, G>
impl<'a, G> Unpin for Dot<'a, G> where
G: Unpin,
impl<'a, G> !UnwindSafe for Dot<'a, G>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.