Struct HydroMermaid 

pub struct HydroMermaid<'a, W> { /* private fields */ }

Available on crate feature viz only.

Mermaid graph writer for Hydro IR.

Implementations

impl<'a, W> HydroMermaid<'a, W>

pub fn new(write: W) -> Self

pub fn new_with_config(write: W, config: HydroWriteConfig<'a>) -> Self

Trait Implementations

impl<W> HydroGraphWrite for HydroMermaid<'_, W>

where W: Write,

type Err = Error

Error type emitted by writing.

fn write_prologue(&mut self) -> Result<(), Self::Err>

Begin the graph. First method called.

fn write_node_definition( &mut self, node_id: VizNodeKey, node_label: &NodeLabel, node_type: HydroNodeType, _location_id: Option<LocationKey>, _location_type: Option<LocationType>, _backtrace: Option<&Backtrace>, ) -> Result<(), Self::Err>

Write a node definition with styling.

fn write_edge( &mut self, src_id: VizNodeKey, dst_id: VizNodeKey, edge_properties: &HashSet<HydroEdgeProp>, label: Option<&str>, ) -> Result<(), Self::Err>

Write an edge between nodes with optional labeling.

fn write_location_start( &mut self, location_key: LocationKey, location_type: LocationType, ) -> Result<(), Self::Err>

Begin writing a location grouping (process/cluster).

fn write_node(&mut self, node_id: VizNodeKey) -> Result<(), Self::Err>

Write a node within a location.

fn write_location_end(&mut self) -> Result<(), Self::Err>

End writing a location grouping.

fn write_epilogue(&mut self) -> Result<(), Self::Err>

End the graph. Last method called.