Enum RenderError 

pub enum RenderError {
    ArgumentUndeclared {
        command: String,
        parameter: String,
    },
    ArgumentMissing {
        command: String,
        parameter: String,
    },
    ArgumentTypeMismatch {
        command: String,
        parameter: String,
        observed: String,
        declared: &'static str,
        supplied: &'static str,
    },
    LeadingDashOperand {
        command: String,
        argument: String,
        element: String,
        marker: &'static str,
    },
    UnboundHole {
        command: String,
        parameter: String,
    },
    PriorFormUnrenderable {
        command: String,
        construct: String,
    },
    UnrepresentableValue {
        parameter: String,
        kind: &'static str,
    },
    InteriorNul {
        parameter: String,
    },
}

Why a declared command could not be rendered into an argv.

Every variant is TERMINAL for an executing action: the same parameter set against the same declaration fails identically however many times it is retried. The AWL side maps each of these back onto its own cause vocabulary with a source span; an executor reports the message as it stands.

Variants

ArgumentUndeclared

The parameter set names something the command does not declare.

Fields

command: String

The command being rendered.

parameter: String

The undeclared name that was supplied.

ArgumentMissing

A declared parameter has neither a supplied value nor a default.

Fields

command: String

The command being rendered.

parameter: String

The parameter nothing filled.

ArgumentTypeMismatch

A supplied value’s shape does not match the parameter’s declared type.

Fields

command: String

The command being rendered.

parameter: String

The parameter whose shape did not match.

observed: String

The value that was supplied, as a diagnostic reads it. Carried rather than re-derived: the bytes a reader must be handed are the ones that were actually seen.

declared: &'static str

The declared shape, as a diagnostic reads it.

supplied: &'static str

The supplied shape, as a diagnostic reads it.

LeadingDashOperand

An operand would emit leading-dash bytes into a position the program is still reading options in, with no end-of-options marker before it.

Fields

command: String

The command being rendered.

argument: String

How the declaration names the offending argument.

element: String

The element that would have been emitted.

marker: &'static str

The end-of-options marker the declaration could have carried.

UnboundHole

A command line reads a parameter the command does not declare, so the declaration and its own body disagree and no parameter set could reconcile them.

Unreachable for a contract the emitter produced — the check layer refuses a hole naming an undeclared parameter before emission — so this names an archive whose stored contract was hand-edited, or one whose body and parameter list were assembled from different sources. Refused rather than rendered as empty text: an argv silently missing a value is a DIFFERENT command running under the author’s name.

Fields

command: String

The command being rendered.

parameter: String

The parameter the body reads and the declaration does not have.

PriorFormUnrenderable

The command was read from a prior-form archive and carries a construct the current form cannot express, so executing it could not mean what its author wrote.

Fields

command: String

The command being rendered.

construct: String

The prior-form construct, named by the reader that found it.

UnrepresentableValue

A supplied value has no unambiguous argument form.

Fields

parameter: String

The parameter whose value could not be rendered.

kind: &'static str

The JSON kind that was supplied.

InteriorNul

A supplied string contains a NUL byte.

Refused rather than truncated: an argument reaches the kernel as a NUL-terminated string, so a NUL inside a value would silently cut the argument short and change what the program receives.

Fields

parameter: String

The parameter whose value carried the NUL.

Trait Implementations

impl Clone for RenderError

fn clone(&self) -> RenderError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderError

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

Formats the value using the given formatter.

impl Display for RenderError

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

Formats the value using the given formatter.

impl Eq for RenderError

impl Error for RenderError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for RenderError

fn eq(&self, other: &RenderError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RenderError