Struct ExplainOutput 

pub struct ExplainOutput {
    pub id: String,
    pub name: String,
    pub summary: String,
    pub rationale: String,
    pub example: String,
    pub how_to_fix: String,
    pub docs: String,
}

Envelope emitted by fallow explain <issue-type> --format json.

Standalone rule explanation. This command does not run project analysis and intentionally returns a compact object without schema_version / version metadata; consumers that need those should call any other fallow JSON-producing command.

Fields

id: String

Issue-type identifier, e.g. unused-export.

name: String

Human-readable issue-type name.

summary: String

One-line description of what the issue type reports.

rationale: String

Why the issue matters.

example: String

Illustrative code example of the issue.

how_to_fix: String

How to resolve findings of this type.

docs: String

Public documentation URL for the issue type.

Trait Implementations

impl Clone for ExplainOutput

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 ExplainOutput

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

Formats the value using the given formatter.

impl Serialize for ExplainOutput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.