vizz 0.2.0

Tool for creating GraphViz/DOT visualizations of Rust data structures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! The `Visualize` trait allows any Rust data structure to be graphically represented using
//! GraphViz and Dot.
//!
//! This crate is currently a work in progress. Major TODO items:
//!
//! 1. Create derive macro for automatically implementing Visualize for arbitrary types
//! 1. Create impls for std library types
//! 1. Replace the crate::util::html_encode method with a proper implementation
//! 1. Replace this list with an ez intro to the lib, which will probably look just like the
//!    [Graph] docs
//! 1. Automatically add referenced data to graphs
//!
//! Early adopters can make use of this crate by manually implementing [Visualize].
//!
//! Users will want to use the [Graph] datatype to generate visualizations.

// set some allowed lints to warnings based on https://rust-unofficial.github.io/patterns/anti_patterns/deny-warnings.html#alternatives
#![warn(
    missing_debug_implementations,
    missing_docs,
    trivial_casts,
    trivial_numeric_casts,
    unused_extern_crates,
    unused_import_braces,
    unused_qualifications,
    unused_results
)]

mod constants;
mod data_description;
mod graph;
mod impls;
#[doc(hidden)]
pub mod util;
mod visualize;

pub use crate::data_description::DataDescription;
pub use crate::data_description::Value;
pub use crate::graph::Graph;
pub use crate::visualize::Visualize;

#[cfg(feature = "derive")]
pub use vizz_derive::Visualize;