Struct ErrorOutput 

pub struct ErrorOutput {
    pub error: bool,
    pub message: String,
    pub exit_code: u8,
    pub code: Option<String>,
    pub help: Option<String>,
}

Structured JSON error emitted on stdout when --format json is active and a command fails. It carries no kind discriminator: it is distinguished from the kind-tagged success envelopes by the required error: true field, and is a document-root branch alongside FallowOutput and CodeClimateOutput in docs/output-schema.json. Agents that pass --format json and observe a non-zero exit code parse this shape from stdout.

Fields

error: bool

Always true. The discriminator that separates an error document from a success envelope (which instead carries a kind).

message: String

Human-readable error message.

exit_code: u8

The process exit code the CLI returns alongside this document.

code: Option<String>

Stable machine-readable code such as FALLOW_INVALID_COVERAGE_PATH, when the failure has one. Present so an agent can branch on the reason without pattern-matching the human message.

help: Option<String>

Remediation hint for the caller, when the failure has one.

Implementations

impl ErrorOutput

pub fn new(message: impl Into<String>, exit_code: u8) -> Self

Build an error envelope for the given message and exit code.

pub fn with_code(self, code: Option<String>) -> Self

Attach a stable machine-readable code.

pub fn with_help(self, help: Option<String>) -> Self

Attach a remediation hint.

Trait Implementations

impl Clone for ErrorOutput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorOutput

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

Formats the value using the given formatter.

impl Serialize for ErrorOutput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.