Struct ValidationIssue 

#[non_exhaustive]
pub struct ValidationIssue {
    pub severity: Severity,
    pub code: IssueCode,
    pub message: String,
    pub span: Option<Span>,
    pub suggestion: Option<String>,
    pub command: Option<String>,
}

A validation issue found in the script.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

severity: Severity

Severity level.

code: IssueCode

Issue category code.

message: String

Human-readable message.

span: Option<Span>

Optional source location.

suggestion: Option<String>

Optional suggestion for fixing the issue.

command: Option<String>

The command this issue concerns, when one is genuinely known.

Some(name) when a name is on hand: a builtin’s own Tool::validate raising about itself, a schema-driven argument issue (the schema’s name), a wrapped command’s refusal, UndefinedCommand’s unresolved name, scatter without a gather, and a user tool’s arity failure.

None, never a placeholder, when the issue is not about a command at all — an assignment target, a bare break, an undefined variable, or MixedScriptName, where the mis-spelled name is the argument.

Severity varies: UndefinedCommand is a Warning and so never reaches KernelError::Validation, which kaish-kernel filters to Error. Reading it means driving the Validator directly.

One limit: schema-driven issues record the SCHEMA’s name, which equals the invoked name for every builtin (pinned by a registry test) but is not enforced for a tool an embedder registers.

Route on code, then narrow by command; don’t parse message to recover a name this field already gives you.

Implementations

impl ValidationIssue

pub fn error(code: IssueCode, message: impl Into<String>) -> Self

Create a new validation error.

pub fn warning(code: IssueCode, message: impl Into<String>) -> Self

Create a new validation warning.

pub fn with_span(self, span: Span) -> Self

Add a span to this issue.

pub fn with_suggestion(self, suggestion: impl Into<String>) -> Self

Add a suggestion to this issue.

pub fn with_command(self, command: impl Into<String>) -> Self

Record the command this issue concerns.

Call this only where the name is genuinely known at the construction site — the tool being validated, or the unresolved name itself for UndefinedCommand. Leave it unset rather than guess.

pub fn format(&self, source: &str) -> String

Format the issue for display.

With source provided, includes line:column information and source context.

Trait Implementations

impl Clone for ValidationIssue

fn clone(&self) -> ValidationIssue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationIssue

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

Formats the value using the given formatter.

impl Display for ValidationIssue

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

Formats the value using the given formatter.