Struct VisgraphDoc 

pub struct VisgraphDoc<W: Write> { /* private fields */ }

Available on crate feature diagnostics only.

Debugger outputting Visgraph dot file.

Notice: This struct is only available if the diagnostics feature has been activated.

The Visgraph Doctor generates a DOT graph about the dependencies of the builders and generated artifacts.

Example

use std::fs::File;
use daab::rc::Cache;
use daab::diagnostics::{VisgraphDoc, VisgraphDocOptions};

let mut cache = Cache::new_with_doctor(
    VisgraphDoc::new(
        VisgraphDocOptions {
            show_builder_values: false,
            show_artifact_values: true,
        },
        File::create("test-graph.dot").unwrap()
    )
);

//...

Example output in DOT format:

strict digraph { graph [labeljust = l];
  "0x7faf30003960" [label = "alloc::rc::Rc<daab::test::BuilderSimpleNode>"]
  "0x7faf30005090" [label = "alloc::rc::Rc<daab::test::BuilderLeaf>"]
  "0x7faf30003960" -> "0x7faf30005090"
  "0x7faf30005090" [label = "alloc::rc::Rc<daab::test::BuilderLeaf>"]
  "0.0-0x7faf30015710" [label = "#0.0 daab::test::Leaf :
Leaf {
    id: 0,
}", shape = box]
  "0x7faf30005090" -> "0.0-0x7faf30015710" [arrowhead = "none"]
}

Implementations

impl<W: Write> VisgraphDoc<W>

pub fn new(opts: VisgraphDocOptions, output: W) -> Self

Creates a new Visgraph Doctor

pub fn into_inner(self) -> W

Dismantles this struct and returns the inner Write.

Trait Implementations

impl<ArtCan: CanBase, BCan, W: Write> Doctor<ArtCan, BCan> for VisgraphDoc<W>

fn resolve(&mut self, builder: &BuilderHandle<BCan>, used: &BuilderHandle<BCan>)

One Builder resolves another Builder.

fn build( &mut self, builder: &BuilderHandle<BCan>, artifact: &ArtifactHandle<ArtCan>, )

One Builder builds its artifact.

fn clear(&mut self)

The entire cache is cleared via ArtifactCache::clear().

fn invalidate(&mut self, _builder: &BuilderHandle<BCan>)

The given Builder is invalidate.

impl<W: Write> Drop for VisgraphDoc<W>

fn drop(&mut self)

Executes the destructor for this type.