Skip to main content

write_checkstyle

Function write_checkstyle 

Source
pub fn write_checkstyle<W: Write>(
    offenders: &[OffenderRecord],
    writer: W,
) -> Result<()>
Expand description

Write Checkstyle 4.3 XML for offenders to writer.

Offenders are grouped by path (sorted lexicographically by the UTF-8 representation; non-UTF-8 paths are skipped with a warning to stderr) so the output is deterministic and snapshot-friendly. Within a file, errors retain their input order.

The empty case still emits a well-formed <checkstyle version="4.3"/> document so consumers can rely on a non-empty file always being parseable.

ยงErrors

Propagates any io::Error returned by writer while emitting the XML envelope, the per-file <file> blocks, or their contained <error> elements.