Skip to main content

ReportGenerator

sbom_tools::reports

Trait ReportGenerator 

Source 
pub trait ReportGenerator {
    // Required methods
    fn generate_diff_report(
        &self,
        result: &DiffResult,
        old_sbom: &NormalizedSbom,
        new_sbom: &NormalizedSbom,
        config: &ReportConfig,
    ) -> Result<String, ReportError>;
    fn generate_view_report(
        &self,
        sbom: &NormalizedSbom,
        config: &ReportConfig,
    ) -> Result<String, ReportError>;
    fn format(&self) -> ReportFormat;

    // Provided method
    fn write_diff_report(
        &self,
        result: &DiffResult,
        old_sbom: &NormalizedSbom,
        new_sbom: &NormalizedSbom,
        config: &ReportConfig,
        writer: &mut dyn Write,
    ) -> Result<(), ReportError> { ... }
}
Expand description

Trait for report generators

Required Methods§

Source

fn generate_diff_report( &self, result: &DiffResult, old_sbom: &NormalizedSbom, new_sbom: &NormalizedSbom, config: &ReportConfig, ) -> Result<String, ReportError>

Generate a report from diff results

Source

fn generate_view_report( &self, sbom: &NormalizedSbom, config: &ReportConfig, ) -> Result<String, ReportError>

Generate a report for a single SBOM (view mode)

Source

fn format(&self) -> ReportFormat

Get the format this generator produces

Provided Methods§

Source

fn write_diff_report( &self, result: &DiffResult, old_sbom: &NormalizedSbom, new_sbom: &NormalizedSbom, config: &ReportConfig, writer: &mut dyn Write, ) -> Result<(), ReportError>

Write report to a writer

Implementors§