Trait HydroGraphWrite 

pub trait HydroGraphWrite {
    type Err: Error;

    // Required methods
    fn write_prologue(&mut self) -> Result<(), Self::Err>;
    fn write_node_definition(
        &mut self,
        node_id: VizNodeKey,
        node_label: &NodeLabel,
        node_type: HydroNodeType,
        location_key: Option<LocationKey>,
        location_type: Option<LocationType>,
        backtrace: Option<&Backtrace>,
    ) -> Result<(), Self::Err>;
    fn write_edge(
        &mut self,
        src_id: VizNodeKey,
        dst_id: VizNodeKey,
        edge_properties: &HashSet<HydroEdgeProp>,
        label: Option<&str>,
    ) -> Result<(), Self::Err>;
    fn write_location_start(
        &mut self,
        location_key: LocationKey,
        location_type: LocationType,
    ) -> Result<(), Self::Err>;
    fn write_node(&mut self, node_id: VizNodeKey) -> Result<(), Self::Err>;
    fn write_location_end(&mut self) -> Result<(), Self::Err>;
    fn write_epilogue(&mut self) -> Result<(), Self::Err>;
}

Available on crate feature viz only.

Trait for writing textual representations of Hydro IR graphs, i.e. mermaid or dot graphs.

Required Associated Types

type Err: Error

Error type emitted by writing.

Required Methods

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_key: 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.

Implementations on Foreign Types

impl<'a, T: 'a + HydroGraphWrite + ?Sized> HydroGraphWrite for &'a mut T

type Err = <T as HydroGraphWrite>::Err

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

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

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

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

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

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

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

impl<T: HydroGraphWrite + ?Sized> HydroGraphWrite for Box<T>

type Err = <T as HydroGraphWrite>::Err

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

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

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

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

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

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

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

Implementors

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

where W: Write,

type Err = Error

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

where W: Write,

type Err = Error

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

where W: Write,

type Err = Error