Skip to main content

HealthOutput

Struct HealthOutput 

Source
pub struct HealthOutput<Report, Group> {
    pub schema_version: SchemaVersion,
    pub version: ToolVersion,
    pub elapsed_ms: ElapsedMs,
    pub report: Report,
    pub grouped_by: Option<GroupByMode>,
    pub groups: Option<Vec<Group>>,
    pub group_filter: Option<Vec<String>>,
    pub gate_outcomes: Option<GateOutcomes>,
    pub request_outcomes: Option<RequestOutcomes>,
    pub meta: Option<Meta>,
    pub workspace_diagnostics: Vec<WorkspaceDiagnostic>,
    pub next_steps: Vec<NextStep>,
}
Expand description

Envelope emitted by fallow health --format json (plus the health block inside the combined and audit envelopes).

The body is HealthReport flattened into the envelope so every report field (findings, summary, vital_signs, hotspots, actions_meta, …) lives at the top level. Grouped runs populate grouped_by + groups with per-bucket recomputed metrics. The actions_meta breadcrumb is modeled on HealthReport as an Option<HealthActionsMeta> and is set at construction time by the report builder when the active HealthActionContext requests suppress-line omission, so the schema documents the field and serde populates it natively.

Fields§

§schema_version: SchemaVersion

Health output schema version.

§version: ToolVersion

Fallow CLI version that produced this output.

§elapsed_ms: ElapsedMs

Wall-clock analysis duration in milliseconds.

§report: Report

Health report body, flattened into the envelope root.

§grouped_by: Option<GroupByMode>

Grouping mode when --group-by was passed.

§groups: Option<Vec<Group>>

Per-bucket recomputed metrics; present only in grouped output.

§group_filter: Option<Vec<String>>

The --group selector patterns, as given, when the run kept only some groups. A group that is not in groups was filtered out by this selector. The project-level sections are not filtered.

§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.

§meta: Option<Meta>

_meta block with metric definitions, when --explain was passed.

§workspace_diagnostics: Vec<WorkspaceDiagnostic>

Workspace-discovery, source-discovery, and analysis-stage diagnostics for the run. See CheckOutput::workspace_diagnostics for the full contract: the kinds each stage records, project-root-relative paths, omitted when empty.

§next_steps: Vec<NextStep>

Read-only follow-up commands computed from this run’s findings. See CheckOutput::next_steps for the contract.

Trait Implementations§

Source§

impl<Report: Clone, Group: Clone> Clone for HealthOutput<Report, Group>

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<Report: Debug, Group: Debug> Debug for HealthOutput<Report, Group>

Source§

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

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

impl<Report, Group> Serialize for HealthOutput<Report, Group>
where Report: Serialize, Group: Serialize,

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§

§

impl<Report, Group> Freeze for HealthOutput<Report, Group>
where Report: Freeze, Option<Vec<Group>>: Freeze,

§

impl<Report, Group> RefUnwindSafe for HealthOutput<Report, Group>
where Report: RefUnwindSafe, Option<Vec<Group>>: RefUnwindSafe,

§

impl<Report, Group> Send for HealthOutput<Report, Group>
where Report: Send, Option<Vec<Group>>: Send,

§

impl<Report, Group> Sync for HealthOutput<Report, Group>
where Report: Sync, Option<Vec<Group>>: Sync,

§

impl<Report, Group> Unpin for HealthOutput<Report, Group>
where Report: Unpin, Option<Vec<Group>>: Unpin,

§

impl<Report, Group> UnsafeUnpin for HealthOutput<Report, Group>
where Report: UnsafeUnpin, Option<Vec<Group>>: UnsafeUnpin,

§

impl<Report, Group> UnwindSafe for HealthOutput<Report, Group>
where Report: UnwindSafe, Option<Vec<Group>>: UnwindSafe,

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