Skip to main content

OutputFormat

Enum OutputFormat 

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

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§

Source§

impl OutputFormat

Source

pub fn is_machine_readable(&self) -> bool

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

Source

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.

Source

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.

Source

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.

Source

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

Create a formatter instance for this format

Trait Implementations§

Source§

impl Clone for OutputFormat

Source§

fn clone(&self) -> OutputFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OutputFormat

Source§

impl Debug for OutputFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for OutputFormat

Source§

type Err = String

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for OutputFormat

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutputFormat

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more