Enum ParseError 

#[non_exhaustive]
pub enum ParseError {
    #[non_exhaustive]
    Expected {
        expected: Cow<'static, str>,
        found: Cow<'static, str>,
        span: Span,
    },
    #[non_exhaustive]
    UnterminatedString {
        span: Span,
    },
    #[non_exhaustive]
    ExpectedAfter {
        expected: Cow<'static, str>,
        after: Cow<'static, str>,
        span: Span,
    },
    #[non_exhaustive]
    UnclosedDelimiter {
        delimiter: Cow<'static, str>,
        opened_at: Span,
        span: Span,
    },
    #[non_exhaustive]
    UnmatchedDelimiter {
        delimiter: Cow<'static, str>,
        span: Span,
    },
    #[non_exhaustive]
    Forbidden {
        rule: ForbiddenRule,
        message: Cow<'static, str>,
        span: Span,
    },
    #[non_exhaustive]
    NestingTooDeep {
        span: Span,
    },
    #[non_exhaustive]
    SourceTooLarge {
        len: usize,
        span: Span,
    },
    #[non_exhaustive]
    VersionTooLow {
        feature: Cow<'static, str>,
        required: PhpVersion,
        used: PhpVersion,
        span: Span,
    },
}

A parse error or diagnostic emitted during parsing.

The parser recovers from all errors and always produces a complete AST, so errors are informational rather than fatal. Each variant carries a Span identifying the source location.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Expected

A specific token was expected but a different one was found.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

expected: Cow<'static, str>

Description of the expected token.

found: Cow<'static, str>

Description of the token actually found, e.g. "';'" or "identifier". A description rather than the lexer’s token kind, so that new tokens are not a breaking change for this type.

span: Span

Source range of the error.

#[non_exhaustive]

UnterminatedString

A string literal was opened but never closed.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

span: Span

Source range of the error.

#[non_exhaustive]

ExpectedAfter

A required token was missing after another construct.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

expected: Cow<'static, str>

Description of the expected token.

after: Cow<'static, str>

Construct the token should follow.

span: Span

Source range of the error.

#[non_exhaustive]

UnclosedDelimiter

A delimiter (parenthesis, bracket, brace) was opened but never closed.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

delimiter: Cow<'static, str>

The expected closing delimiter, e.g. "')'".

opened_at: Span

Where the delimiter was opened.

span: Span

Source range of the error.

#[non_exhaustive]

UnmatchedDelimiter

A closing delimiter with no delimiter open, such as a } after the last block.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

delimiter: Cow<'static, str>

The closing delimiter, e.g. "'}'".

span: Span

Source range of the error.

#[non_exhaustive]

Forbidden

A construct that is syntactically valid but semantically forbidden (e.g. (unset) cast, deprecated syntax). Equivalent to a PHP fatal.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

rule: ForbiddenRule

Rule violated.

message: Cow<'static, str>

Error message.

span: Span

Source range of the error.

#[non_exhaustive]

NestingTooDeep

Statements, expressions or string interpolations are nested deeper than the parser’s recursion budget. The innermost construct is replaced by an error node so that parsing stays within a bounded stack.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

span: Span

Source range of the error.

#[non_exhaustive]

SourceTooLarge

The source is larger than 4 GiB, so byte offsets no longer fit in a Span. Nothing is parsed and the program is empty.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

len: usize

Length of the rejected source in bytes.

span: Span

Always empty (0..0).

#[non_exhaustive]

VersionTooLow

Syntax that requires a newer PHP version than the targeted one. Emitted by crate::parse_with when the source uses features unavailable in the specified crate::PhpVersion.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

feature: Cow<'static, str>

Name of the feature used.

required: PhpVersion

Minimum PHP version required.

used: PhpVersion

PHP version targeted.

span: Span

Source range of the error.

Implementations

impl ParseError

pub fn span(&self) -> Span

Source range of the error.

pub fn forbidden_rule(&self) -> Option<ForbiddenRule>

Rule violated, for ParseError::Forbidden.

pub fn code(&self) -> &'static str

Stable kebab-case identifier: the variant’s, or the rule’s for ParseError::Forbidden.

pub fn leaves_ast_incomplete(&self) -> bool

Whether the AST around the error is a recovery guess rather than what the source says.

Trait Implementations

impl Clone for ParseError

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 ParseError

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

Formats the value using the given formatter.

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.