Visualization

scirs2_metrics::visualization

Trait Visualization 

Source 
pub trait Visualization {
    // Required methods
    fn save_to_file(
        &self,
        path: impl AsRef<Path>,
        options: Option<VisualizationOptions>,
    ) -> Result<(), Box<dyn Error>>;
    fn render_svg(
        &self,
        options: Option<VisualizationOptions>,
    ) -> Result<Vec<u8>, Box<dyn Error>>;
    fn render_png(
        &self,
        options: Option<VisualizationOptions>,
    ) -> Result<Vec<u8>, Box<dyn Error>>;
}
Expand description

Helper functions for saving visualizations

Required Methods§

Source

fn save_to_file( &self, path: impl AsRef<Path>, options: Option<VisualizationOptions>, ) -> Result<(), Box<dyn Error>>

Save the visualization to a file using the default backend

§Arguments
  • path - The output file path
  • options - Optional visualization options
§Returns
  • Result<(), Box<dyn Error>> - Ok if the visualization was successfully saved, or an error if something went wrong
Source

fn render_svg( &self, options: Option<VisualizationOptions>, ) -> Result<Vec<u8>, Box<dyn Error>>

Render the visualization as SVG

§Arguments
  • options - Optional visualization options
§Returns
  • Result<Vec<u8>, Box<dyn Error>> - A byte array containing the SVG representation of the visualization
Source

fn render_png( &self, options: Option<VisualizationOptions>, ) -> Result<Vec<u8>, Box<dyn Error>>

Render the visualization as PNG

§Arguments
  • options - Optional visualization options
§Returns
  • Result<Vec<u8>, Box<dyn Error>> - A byte array containing the PNG representation of the visualization

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§