Enum ParseError 

pub enum ParseError {
    ExtraTokens(Span),
    ExtraTokensAfterClosingDelimiter(Span),
    ExtraPositional(String, Span),
    RequiredAfterOptional(String, Span),
    UnexpectedEof(String, Span),
    Unclosed(&'static str, Span, Span, String),
    Unbalanced(&'static str, &'static str, Span, String),
    Expected(&'static str, Span),
    ExpectedWithStringMsg(String, Span),
    ExpectedWithDidYouMean(&'static str, DidYouMean, Span),
    InputMismatch(String, Span),
    OutputMismatch(Type, String, Span),
    Mismatch(String, String, Span),
    ShellAndAnd(Span),
    ShellOrOr(Span),
    ShellErrRedirect(Span),
    ShellOutErrRedirect(Span),
    MultipleRedirections(RedirectionSource, Span, Span),
    UnexpectedRedirection {
        span: Span,
    },
    OperatorUnsupportedType {
        op: &'static str,
        unsupported: Type,
        op_span: Span,
        unsupported_span: Span,
        help: Option<&'static str>,
    },
    OperatorIncompatibleTypes {
        op: &'static str,
        lhs: Type,
        rhs: Type,
        op_span: Span,
        lhs_span: Span,
        rhs_span: Span,
        help: Option<&'static str>,
    },
    CaptureOfMutableVar(Span),
    ExpectedKeyword(String, Span),
    UnexpectedKeyword(String, Span),
    KeywordShadowModuleMain(String, Span),
    CantAliasKeyword(String, Span),
    CantAliasExpression(String, Span),
    UnknownOperator(&'static str, &'static str, Span),
    BuiltinCommandInPipeline(String, Span),
    AssignInPipeline(String, String, String, Span),
    NameIsBuiltinVar(String, Span),
    NameIsKeyword(String, String, Span),
    IncorrectValue(String, Span, String),
    InvalidBinaryString(Span, String),
    MultipleRestParams(Span),
    VariableNotFound(DidYouMean, Span),
    EnvVarNotVar(String, Span),
    VariableNotValid(Span),
    AliasNotValid(Span),
    CommandDefNotValid(Span),
    ModuleNotFound(Span, String),
    ModuleMissingModNuFile(String, Span),
    CircularImport(String, Span),
    NamedAsModule(String, String, String, Span),
    ModuleDoubleMain(String, Span),
    ExportMainAliasNotAllowed(Span),
    ActiveOverlayNotFound(Span),
    OverlayPrefixMismatch(String, String, Span),
    ModuleOrOverlayNotFound(Span),
    CantRemoveLastOverlay(Span),
    CantHideDefaultOverlay(String, Span),
    CantAddOverlayHelp(String, Span),
    DuplicateCommandDef(Span),
    UnknownCommand(Span),
    NonUtf8(Span),
    UnknownFlag(String, String, Span, String),
    UnknownType(Span),
    MissingFlagParam(String, Span),
    OnlyLastFlagInBatchCanTakeArg(Span),
    MissingPositional(String, Span, String),
    KeywordMissingArgument(String, String, Span),
    MissingType(Span),
    TypeMismatch(Type, Type, Span),
    TypeMismatchHelp(Type, Type, Span, String),
    MissingRequiredFlag(String, Span),
    IncompleteMathExpression(Span),
    UnknownState(String, Span),
    InternalError(String, Span),
    IncompleteParser(Span),
    RestNeedsName(Span),
    ParameterMismatchType(String, String, String, Span),
    NonConstantDefaultValue(Span),
    ExtraColumns(usize, Span),
    MissingColumns(usize, Span),
    AssignmentMismatch(String, String, Span),
    WrongImportPattern(String, Span),
    ExportNotFound(Span),
    SourcedFileNotFound(String, Span),
    ScriptFileTooLarge {
        path: String,
        size: u64,
        max_size: u64,
        span: Span,
    },
    ScriptFileNotText {
        path: String,
        span: Span,
    },
    RegisteredFileNotFound(String, Span),
    FileNotFound(String, Span),
    PluginNotFound {
        name: String,
        name_span: Span,
        plugin_config_span: Option<Span>,
    },
    InvalidLiteral(String, String, Span),
    LabeledError(String, String, Span),
    LabeledErrorWithHelp {
        error: String,
        label: String,
        help: String,
        span: Span,
    },
    RedirectingBuiltinCommand(&'static str, Span, Option<Span>),
    UnexpectedSpreadArg(String, Span),
    AssignmentRequiresMutableVar(Span),
    AssignmentRequiresVar(Span),
    AttributeRequiresDefinition(Span),
}

Variants

ExtraTokens(Span)

The parser encountered unexpected tokens, when the code should have finished. You should remove these or finish adding what you intended to add.

ExtraTokensAfterClosingDelimiter(Span)

ExtraPositional(String, Span)

RequiredAfterOptional(String, Span)

UnexpectedEof(String, Span)

Unclosed(&'static str, Span, Span, String)

A delimiter was opened but never closed.

• 0: expected closer (e.g. "}", "]", ")")
• 1: span of the opening delimiter
• 2: span where the closer was expected (primary — often mid-file or EOF)
• 3: help text (generic or heuristic structure hint)

Primary label is the expected closer location so a deleted } near line N points the user at (or near) line N, not only at a distant opener.

Unbalanced(&'static str, &'static str, Span, String)

A closer appeared without a matching opener (or mismatched kind).

• 0 / 1: open and close delimiter characters (e.g. "{", "}")
• 2: span of the unexpected closer (primary label)
• 3: help text

Expected(&'static str, Span)

ExpectedWithStringMsg(String, Span)

ExpectedWithDidYouMean(&'static str, DidYouMean, Span)

InputMismatch(String, Span)

OutputMismatch(Type, String, Span)

Mismatch(String, String, Span)

ShellAndAnd(Span)

ShellOrOr(Span)

ShellErrRedirect(Span)

ShellOutErrRedirect(Span)

MultipleRedirections(RedirectionSource, Span, Span)

UnexpectedRedirection

Fields

span: Span

OperatorUnsupportedType

One or more of the values have types not supported by the operator.

Fields

op: &'static str

unsupported: Type

op_span: Span

unsupported_span: Span

help: Option<&'static str>

OperatorIncompatibleTypes

The operator supports the types of both values, but not the specific combination of their types.

Fields

op: &'static str

lhs: Type

rhs: Type

op_span: Span

lhs_span: Span

rhs_span: Span

help: Option<&'static str>

CaptureOfMutableVar(Span)

ExpectedKeyword(String, Span)

UnexpectedKeyword(String, Span)

KeywordShadowModuleMain(String, Span)

CantAliasKeyword(String, Span)

CantAliasExpression(String, Span)

UnknownOperator(&'static str, &'static str, Span)

BuiltinCommandInPipeline(String, Span)

AssignInPipeline(String, String, String, Span)

NameIsBuiltinVar(String, Span)

NameIsKeyword(String, String, Span)

IncorrectValue(String, Span, String)

InvalidBinaryString(Span, String)

MultipleRestParams(Span)

VariableNotFound(DidYouMean, Span)

EnvVarNotVar(String, Span)

VariableNotValid(Span)

AliasNotValid(Span)

CommandDefNotValid(Span)

ModuleNotFound(Span, String)

ModuleMissingModNuFile(String, Span)

CircularImport(String, Span)

NamedAsModule(String, String, String, Span)

ModuleDoubleMain(String, Span)

ExportMainAliasNotAllowed(Span)

ActiveOverlayNotFound(Span)

OverlayPrefixMismatch(String, String, Span)

ModuleOrOverlayNotFound(Span)

CantRemoveLastOverlay(Span)

CantHideDefaultOverlay(String, Span)

CantAddOverlayHelp(String, Span)

DuplicateCommandDef(Span)

UnknownCommand(Span)

NonUtf8(Span)

UnknownFlag(String, String, Span, String)

UnknownType(Span)

MissingFlagParam(String, Span)

OnlyLastFlagInBatchCanTakeArg(Span)

MissingPositional(String, Span, String)

KeywordMissingArgument(String, String, Span)

MissingType(Span)

TypeMismatch(Type, Type, Span)

TypeMismatchHelp(Type, Type, Span, String)

MissingRequiredFlag(String, Span)

IncompleteMathExpression(Span)

UnknownState(String, Span)

InternalError(String, Span)

IncompleteParser(Span)

RestNeedsName(Span)

ParameterMismatchType(String, String, String, Span)

NonConstantDefaultValue(Span)

ExtraColumns(usize, Span)

MissingColumns(usize, Span)

AssignmentMismatch(String, String, Span)

WrongImportPattern(String, Span)

ExportNotFound(Span)

SourcedFileNotFound(String, Span)

ScriptFileTooLarge

Fields

path: String

size: u64

max_size: u64

span: Span

ScriptFileNotText

Fields

path: String

span: Span

RegisteredFileNotFound(String, Span)

FileNotFound(String, Span)

PluginNotFound

Fields

name: String

name_span: Span

plugin_config_span: Option<Span>

InvalidLiteral(String, String, Span)

LabeledError(String, String, Span)

LabeledErrorWithHelp

Fields

error: String

label: String

help: String

span: Span

RedirectingBuiltinCommand(&'static str, Span, Option<Span>)

UnexpectedSpreadArg(String, Span)

AssignmentRequiresMutableVar(Span)

Invalid assignment left-hand side

Resolution

Assignment requires that you assign to a mutable variable or cell path.

AssignmentRequiresVar(Span)

Invalid assignment left-hand side

Resolution

Assignment requires that you assign to a variable or variable cell path.

AttributeRequiresDefinition(Span)

Implementations

impl ParseError

pub fn opener_span(span: Span, len: usize) -> Span

Span covering the first len bytes of span (clamped to span.end).

Used when labeling a multi-byte construct’s opening delimiter.

pub fn unclosed( delimiter: &'static str, open_span: Span, end_span: Span, ) -> Self

Build an Unclosed with default help text.

pub fn unclosed_with_hint( delimiter: &'static str, open_span: Span, end_span: Span, structure_hint: Option<&str>, ) -> Self

Build an Unclosed with an optional structure hint (e.g. record field ls, def foo). Empty/None uses generic help.

pub fn unbalanced( open: &'static str, close: &'static str, close_span: Span, ) -> Self

Build an Unbalanced with default help text.

pub fn span(&self) -> Span

Trait Implementations

impl Clone for ParseError

fn clone(&self) -> ParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Deserialize<'static> for ParseError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

impl Diagnostic for ParseError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

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 From<Spanned<InvalidPluginFilename>> for ParseError

fn from(error: Spanned<InvalidPluginFilename>) -> ParseError

Converts to this type from the input type.

impl PartialEq for ParseError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ParseError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParseError