Skip to main content

ReportFormat

Enum ReportFormat 

Source
pub enum ReportFormat {
Show 14 variants Text { color: bool, example_suppressions: usize, dogfood_active: bool, }, Json, JsonEnvelope { coverage_gap_summary: Vec<(String, usize)>, }, Jsonl, JsonlEnvelope { coverage_gap_summary: Vec<(String, usize)>, }, Sarif { skip_summary: Vec<(String, usize)>, }, Csv, GithubAnnotations, GithubAnnotationsCoverage { skip_summary: Vec<(String, usize)>, }, GitlabSast { scan_started_at: String, scan_finished_at: String, }, GitlabSastCoverage { scan_started_at: String, scan_finished_at: String, skip_summary: Vec<(String, usize)>, }, Html { skip_summary: Vec<(String, usize)>, metadata: Option<HtmlScanMetadata>, }, Junit, JunitCoverage { skip_summary: Vec<(String, usize)>, },
}
Expand description

Output format and formatter options for write_report.

Variants§

§

Text

Human-oriented terminal output.

Fields

§color: bool

Emit ANSI color escapes.

§example_suppressions: usize

Number of example suppression hints to include.

§dogfood_active: bool

Include dogfood telemetry hints in the text report.

§

Json

JSON array output.

§

JsonEnvelope

Versioned JSON envelope output and its scan-wide coverage summary.

Fields

§coverage_gap_summary: Vec<(String, usize)>

Non-zero source or scanner coverage gaps observed during the scan.

§

Jsonl

Newline-delimited JSON output.

§

JsonlEnvelope

Versioned newline-delimited JSON output with a stream header.

Fields

§coverage_gap_summary: Vec<(String, usize)>

Non-zero source or scanner coverage gaps observed during the scan.

§

Sarif

SARIF output.

Fields

§skip_summary: Vec<(String, usize)>

Operator-visible scan coverage-gap summary entries.

§

Csv

CSV output.

§

GithubAnnotations

GitHub Actions workflow command annotations.

§

GithubAnnotationsCoverage

GitHub Actions annotations with a terminal scan coverage notice.

Fields

§skip_summary: Vec<(String, usize)>

Non-zero source or scanner coverage gaps observed during the scan.

§

GitlabSast

GitLab SAST security report JSON.

Fields

§scan_started_at: String

UTC scan start time formatted as YYYY-MM-DDTHH:MM:SS.

§scan_finished_at: String

UTC scan end time formatted as YYYY-MM-DDTHH:MM:SS.

§

GitlabSastCoverage

GitLab SAST output with scan-wide coverage status.

Fields

§scan_started_at: String

UTC scan start time formatted as YYYY-MM-DDTHH:MM:SS.

§scan_finished_at: String

UTC scan end time formatted as YYYY-MM-DDTHH:MM:SS.

§skip_summary: Vec<(String, usize)>

Non-zero source or scanner coverage gaps observed during the scan.

§

Html

Self-contained HTML output.

Fields

§skip_summary: Vec<(String, usize)>

Operator-visible scan coverage-gap summary entries (same data the SARIF report surfaces), rendered as a “coverage” panel so the report never reads as a clean bill of health when files went unscanned.

§metadata: Option<HtmlScanMetadata>

Scan identity, timing, target, and size metadata for the report hero.

§

Junit

JUnit XML output.

§

JunitCoverage

JUnit XML output with deterministic scan coverage properties.

Fields

§skip_summary: Vec<(String, usize)>

Non-zero source or scanner coverage gaps observed during the scan.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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