Enum OutputFormat 

pub enum OutputFormat {
    Text,
    Full,
    Concise,
    Grouped,
    Json,
    JsonLines,
    GitHub,
    GitLab,
    Pylint,
    Azure,
    Sarif,
    Junit,
}

Available output formats

Variants

Text

Default human-readable format with colors and context

Full

Full format with source line display (ruff-style)

Concise

Concise format: file:line:col: [RULE] message

Grouped

Grouped format: violations grouped by file

Json

JSON format (existing)

JsonLines

JSON Lines format (one JSON object per line)

GitHub

GitHub Actions annotation format

GitLab

GitLab Code Quality format

Pylint

Pylint-compatible format: file:line:column: CODE message

Azure

Azure Pipeline logging format

Sarif

SARIF 2.1.0 format

Junit

JUnit XML format

Implementations

impl OutputFormat

pub fn is_machine_readable(&self) -> bool

Whether this format produces machine-readable output that should not be mixed with human-readable summary lines.

pub fn is_batch(&self) -> bool

Whether this format is a batch format: a single document spanning all results, which therefore needs every file’s warnings collected before anything is emitted. Streaming formats emit per file as results arrive.

pub fn needs_all_files(&self) -> bool

Whether this batch format also reports passing files and therefore needs every checked file’s path, not just the warning-bearing ones.

pub fn format_batch( &self, file_warnings: &[(String, Vec<LintWarning>)], all_files: &[String], duration_ms: u64, ) -> Option<String>

Format the complete result set for a batch format. Returns None for streaming formats, so callers can fall through to per-file output without matching on the variants themselves.

all_files and duration_ms are consumed only by formats that report passing files and run time (JUnit); issue-list formats ignore them.

pub fn create_formatter(&self) -> Box<dyn OutputFormatter>

Create a formatter instance for this format

Trait Implementations

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OutputFormat

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl FromStr for OutputFormat

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 OutputFormat

fn eq(&self, other: &OutputFormat) -> 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 OutputFormat