Struct petgraph::dot::Dot

source ·
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§

source§

impl<'a, G> Dot<'a, G>where G: IntoNodeReferences + IntoEdgeReferences,

source

pub fn new(graph: G) -> Self

Create a Dot formatting wrapper with default configuration.

source

pub fn with_config(graph: G, config: &'a [Config]) -> Self

Create a Dot formatting wrapper with custom configuration.

source

pub fn with_attr_getters( graph: G, config: &'a [Config], get_edge_attributes: &'a dyn Fn(G, G::EdgeRef) -> String, get_node_attributes: &'a dyn Fn(G, G::NodeRef) -> String ) -> Self

Trait Implementations§

source§

impl<'a, G> Debug for Dot<'a, G>where G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp, G::EdgeWeight: Debug, G::NodeWeight: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a, G> Display for Dot<'a, G>where G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp, G::EdgeWeight: Display, G::NodeWeight: Display,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.