Skip to main content

CheckGroupedOutput

Struct CheckGroupedOutput 

Source
pub struct CheckGroupedOutput {
Show 15 fields pub schema_version: SchemaVersion, pub version: ToolVersion, pub elapsed_ms: ElapsedMs, pub grouped_by: GroupByMode, pub total_issues: usize, pub groups: Vec<CheckGroupedEntry>, pub unused_load_data_keys_global_abstain: bool, pub baseline_staleness: Option<BaselineStaleness>, pub finding_id_query: Option<FindingIdQuery>, pub gate_outcomes: Option<GateOutcomes>, pub request_outcomes: Option<RequestOutcomes>, pub package_baselines: Vec<PackageBaselineStatus>, pub meta: Option<Meta>, pub workspace_diagnostics: Vec<WorkspaceDiagnostic>, pub next_steps: Vec<NextStep>,
}
Expand description

Envelope emitted by fallow dead-code --group-by ... --format json.

Issues are partitioned into resolver buckets (CODEOWNERS team, directory prefix, workspace package, or GitLab CODEOWNERS section) instead of flat arrays. Each bucket carries the same issue-array shape as the ungrouped CheckOutput body, plus per-group key / owners / total_issues.

Fields§

§schema_version: SchemaVersion

Dead-code output schema version; currently CHECK_SCHEMA_VERSION.

§version: ToolVersion

Fallow CLI version that produced this output.

§elapsed_ms: ElapsedMs

Wall-clock analysis duration in milliseconds.

§grouped_by: GroupByMode

Resolver the issues were grouped by.

§total_issues: usize

Total findings across all groups.

§groups: Vec<CheckGroupedEntry>

One bucket per resolver key.

§unused_load_data_keys_global_abstain: bool

true when the unused-load-data-key detector abstained for the whole project. The abstain has no file, so it is on the root and not in a group. An empty unused_load_data_keys with this flag set does not mean the project is clean: the rule could not run safely. Serialized only when true, like the flat CheckOutput field.

§baseline_staleness: Option<BaselineStaleness>

This run’s view of the loaded baseline, present only in baseline runs. Carries the staleness counts, the advisory verdict and gate_trips, the same boolean --fail-on-stale-baseline exits on, so a CI integration reads one field instead of restating the rule. Read change_scoped before dividing matched_entries by baseline_entries: a narrowed run can report matched_entries: 0 on a healthy baseline.

§finding_id_query: Option<FindingIdQuery>

The answer to --finding-id, present only when the run received one or more --finding-id values. The report then holds only the requested findings. Read missing as resolved only when conclusive is true; a scope, a baseline or a filter can hide a finding that still exists. See crate::FindingIdQuery.

§gate_outcomes: Option<GateOutcomes>

The verdict of every gate this run evaluated, keyed by name. The CLI always emits it, with the command’s default exit rule in it also when no flag armed a gate, so a CI integration reads the verdict instead of guessing from a process status it usually cannot see. A gate fails the build when status is fail AND enforced is true. The typed programmatic API runs no CLI gate and leaves it absent. See crate::GateOutcomes.

§request_outcomes: Option<RequestOutcomes>

Every narrowing or shaping request this run RECEIVED, keyed by name, absent when it was asked for nothing. An entry whose status is not applied means the run could not do what it was asked and reported something WIDER instead, so what follows is a valid report of a scope nobody requested. Honoured requests are published too, with status: "applied", so an absent object means “nothing was asked for”, never “nothing failed”. See crate::RequestOutcomes.

§package_baselines: Vec<PackageBaselineStatus>

Applied package Git refs, omitted outside package-baseline runs.

§meta: Option<Meta>

_meta block with docs and rule definitions, when --explain was passed.

§workspace_diagnostics: Vec<WorkspaceDiagnostic>

Diagnostics collected for the full analysis before issue grouping. See CheckOutput::workspace_diagnostics for the contract.

§next_steps: Vec<NextStep>

Read-only follow-up commands computed from the full (ungrouped) findings. See CheckOutput::next_steps for the contract.

Trait Implementations§

Source§

impl Clone for CheckGroupedOutput

Source§

fn clone(&self) -> Self

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 Debug for CheckGroupedOutput

Source§

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

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

impl Serialize for CheckGroupedOutput

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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