Enum Format 

pub enum Format {
    Human,
    Json,
    Sarif,
    Github,
    Markdown,
    Junit,
    Gitlab,
    Agent,
}

Variants

Human

Json

Sarif

Github

Markdown

Junit

Gitlab

Agent

Implementations

impl Format

pub fn write(self, report: &Report, w: &mut dyn Write) -> Result<()>

Write a check-report. Convenience wrapper that uses default HumanOptions (Unicode glyphs, no hyperlinks). Callers that care about glyph fallback or hyperlink support — i.e. the CLI — should use Format::write_with_options.

pub fn write_with_options( self, report: &Report, w: &mut dyn Write, opts: HumanOptions, ) -> Result<()>

Like Format::write, but with explicit rendering options. Only the Human format inspects opts; the others ignore it.

pub fn write_fix(self, report: &FixReport, w: &mut dyn Write) -> Result<()>

Write a fix-report. Human, Json, and Markdown have dedicated renderers; SARIF, GitHub annotations, JUnit, and GitLab Code Quality describe findings, not remediations, so they fall back to the human formatter for fix reports.

pub fn write_fix_with_options( self, report: &FixReport, w: &mut dyn Write, opts: HumanOptions, ) -> Result<()>

Like Format::write_fix, but with explicit rendering options.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl FromStr for Format

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Format

fn eq(&self, other: &Format) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Format