Struct Reporter 

pub struct Reporter { /* private fields */ }

The main reporter that handles formatting and outputting issues.

The reporter takes a collection of issues and outputs them according to the configured format and options. It can apply baseline filtering, severity filtering, and sorting before output.

Implementations

impl Reporter

pub fn new(database: ReadDatabase, config: ReporterConfig) -> Self

Create a new reporter with the given database and configuration.

pub fn report( &self, issues: IssueCollection, baseline: Option<Baseline>, ) -> Result<ReportStatus, ReportingError>

Report issues to the configured target.

This method applies baseline filtering, severity filtering, and sorting based on the reporter configuration, then formats and outputs the issues.

Errors

Returns a ReportingError if formatting or writing the issues fails.

pub fn report_to<W: Write>( &self, issues: IssueCollection, baseline: Option<Baseline>, writer: &mut W, ) -> Result<ReportStatus, ReportingError>

Report issues to a custom writer.

This method allows writing to any Write implementation, making it useful for testing, capturing output to strings, writing to files, or streaming over network sockets.

Errors

Returns a ReportingError if formatting or writing the issues fails.

Examples

// Write to a buffer for testing
let mut buffer = Vec::new();
reporter.report_to(issues, None, &mut buffer)?;
let output = String::from_utf8(buffer)?;

// Write to a file
let mut file = File::create("report.txt")?;
reporter.report_to(issues, None, &mut file)?;

Trait Implementations

impl Debug for Reporter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.