Skip to main content

AuditOutput

Struct AuditOutput 

Source
pub struct AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> {
Show 18 fields pub schema_version: SchemaVersion, pub version: ToolVersion, pub command: AuditCommand, pub verdict: Verdict, pub changed_files_count: u32, pub base_ref: String, pub base_description: Option<String>, pub head_sha: Option<String>, pub elapsed_ms: ElapsedMs, pub base_snapshot_skipped: Option<bool>, pub summary: Summary, pub attribution: Attribution, pub gate_outcomes: Option<GateOutcomes>, pub meta: Option<Meta>, pub dead_code: Option<DeadCode>, pub duplication: Option<Duplication>, pub complexity: Option<Complexity>, pub next_steps: Vec<NextStep>,
}
Expand description

fallow audit --format json envelope.

Fields§

§schema_version: SchemaVersion

Audit output schema version.

§version: ToolVersion

Fallow CLI version that produced this output.

§command: AuditCommand

Command discriminator singleton: always audit.

§verdict: Verdict

Gate verdict for the audited change.

§changed_files_count: u32

Number of changed files in the audit scope.

§base_ref: String

Git ref the change was diffed against.

§base_description: Option<String>

Human-readable provenance of base_ref, e.g. merge-base with origin/main, local main, or FALLOW_AUDIT_BASE=upstream/main. Present when the base was auto-detected or set via FALLOW_AUDIT_BASE; absent for an explicit --base (the ref the user typed is already self-describing).

§head_sha: Option<String>

Commit SHA of the audited head tree, when resolvable.

§elapsed_ms: ElapsedMs

Wall-clock analysis duration in milliseconds.

§base_snapshot_skipped: Option<bool>

True when base-snapshot analysis was skipped, so new-vs-inherited attribution could not run.

§summary: Summary

Aggregate finding counts for the audited change.

§attribution: Attribution

New-vs-inherited attribution of findings against the base.

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

§meta: Option<Meta>

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

§dead_code: Option<DeadCode>

Dead-code findings scoped to the audit changeset.

§duplication: Option<Duplication>

Duplication findings scoped to the audit changeset.

§complexity: Option<Complexity>

Complexity findings scoped to the audit changeset.

§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<Verdict: Clone, Summary: Clone, Attribution: Clone, DeadCode: Clone, Duplication: Clone, Complexity: Clone> Clone for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>

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<Verdict: Debug, Summary: Debug, Attribution: Debug, DeadCode: Debug, Duplication: Debug, Complexity: Debug> Debug for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>

Source§

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

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

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> Serialize for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: Serialize, Summary: Serialize, Attribution: Serialize, DeadCode: Serialize, Duplication: Serialize, Complexity: 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<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> Freeze for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: Freeze, Summary: Freeze, Attribution: Freeze, Option<DeadCode>: Freeze, Option<Duplication>: Freeze, Option<Complexity>: Freeze,

§

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> RefUnwindSafe for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: RefUnwindSafe, Summary: RefUnwindSafe, Attribution: RefUnwindSafe, Option<DeadCode>: RefUnwindSafe, Option<Duplication>: RefUnwindSafe, Option<Complexity>: RefUnwindSafe,

§

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> Send for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: Send, Summary: Send, Attribution: Send, Option<DeadCode>: Send, Option<Duplication>: Send, Option<Complexity>: Send,

§

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> Sync for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: Sync, Summary: Sync, Attribution: Sync, Option<DeadCode>: Sync, Option<Duplication>: Sync, Option<Complexity>: Sync,

§

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> Unpin for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: Unpin, Summary: Unpin, Attribution: Unpin, Option<DeadCode>: Unpin, Option<Duplication>: Unpin, Option<Complexity>: Unpin,

§

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> UnsafeUnpin for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: UnsafeUnpin, Summary: UnsafeUnpin, Attribution: UnsafeUnpin, Option<DeadCode>: UnsafeUnpin, Option<Duplication>: UnsafeUnpin, Option<Complexity>: UnsafeUnpin,

§

impl<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity> UnwindSafe for AuditOutput<Verdict, Summary, Attribution, DeadCode, Duplication, Complexity>
where Verdict: UnwindSafe, Summary: UnwindSafe, Attribution: UnwindSafe, Option<DeadCode>: UnwindSafe, Option<Duplication>: UnwindSafe, Option<Complexity>: 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