Enum ParseError 

pub enum ParseError {
    UnexpectedChar(char, usize),
    UnexpectedEof(usize),
    InvalidNumber(usize),
    InvalidEscape(usize),
    InvalidUnicode(usize),
    UnterminatedString(usize),
    TrailingComma(usize),
    Expected {
        expected: String,
        found: String,
        position: usize,
    },
    DepthLimitExceeded(usize),
    Custom(String),
    WithContext {
        message: String,
        source: Box<Error>,
    },
    RepairFailed(String),
    BracketMismatch(usize, char, char),
    UnbalancedBrackets(usize, usize),
    MaxRepairsExceeded(usize),
    InvalidUtf8(usize),
    InvalidChunk(String),
}

Error types that can occur during vexy_json parsing.

Each error variant contains positional information to help users locate and fix parsing issues in their input. The error types are designed to provide clear, actionable feedback.

Variants

UnexpectedChar(char, usize)

Unexpected character encountered during parsing. Contains the character and its position in the input.

UnexpectedEof(usize)

Unexpected end of input while parsing. Contains the position where more input was expected.

InvalidNumber(usize)

Invalid number format encountered. Contains the position where the invalid number starts.

InvalidEscape(usize)

Invalid escape sequence in string. Contains the position of the invalid escape.

InvalidUnicode(usize)

Invalid unicode escape sequence. Contains the position of the invalid unicode escape.

UnterminatedString(usize)

String literal was not properly terminated. Contains the position where the string started.

TrailingComma(usize)

Trailing comma found when not allowed by parser options. Contains the position of the trailing comma.

Expected

Expected a specific token or value but found something else. This is the most flexible error type for parser expectations.

Fields

expected: String

Description of what was expected.

found: String

Description of what was actually found.

position: usize

Position in the input where the mismatch occurred.

DepthLimitExceeded(usize)

Maximum recursion depth exceeded while parsing nested structures. Contains the position where the limit was exceeded.

Custom(String)

Custom error with a descriptive message. Used for configuration errors or other non-positional issues.

WithContext

An error that wraps another error, adding context.

Fields

message: String

A descriptive message for the context.

source: Box<Error>

The source error.

RepairFailed(String)

JSON repair failed with the given error message.

BracketMismatch(usize, char, char)

Bracket mismatch detected during parsing.

UnbalancedBrackets(usize, usize)

Unbalanced brackets detected.

MaxRepairsExceeded(usize)

Maximum repair attempts exceeded.

InvalidUtf8(usize)

Invalid UTF-8 sequence encountered.

InvalidChunk(String)

Invalid chunk detected during parallel processing.

Implementations

impl Error

pub fn code(&self) -> ErrorCode

Returns the error code for this error.

Error codes provide a structured way to identify and categorize different types of parsing errors programmatically.

pub fn position(&self) -> Option<usize>

Returns the position in the input where the error occurred, if available.

Most parsing errors have associated position information to help users locate the problematic input. Custom errors may not have position information and will return None.

pub fn span(&self) -> Option<Span>

Returns a span covering the error location, if available.

This provides more precise location information than just a position, including the range of characters that caused the error.

pub fn suggestions(&self) -> Vec<&'static str>

Returns suggestions for fixing this error.

Provides context-aware suggestions based on the error type and the specific situation that caused the error.

pub fn diagnostic(&self) -> String

Returns a detailed diagnostic message including error code and suggestions.

This provides a comprehensive error report that includes the original error message, error code, and actionable suggestions for fixing the issue. For colored output, use diagnostic_colored or diagnostic_with_formatter.

pub fn diagnostic_with_formatter(&self, formatter: &TerminalFormatter) -> String

Returns a detailed diagnostic message with colored terminal formatting.

This method provides the same comprehensive error report as diagnostic() but uses colored output when the terminal supports it. Colors enhance readability by highlighting error codes, messages, and suggestions.

pub fn diagnostic_colored(&self) -> String

Returns a detailed diagnostic message with colored output if terminal supports it.

This is a convenience method that automatically detects terminal capabilities and uses colored output when available, falling back to plain text otherwise.

pub fn diagnostic_plain(&self) -> String

Returns a detailed diagnostic message with plain text output (no colors).

This is a convenience method for when you specifically want plain text output regardless of terminal capabilities.

pub fn with_context<S>(self, message: S) -> Error

where S: Into<String>,

Creates a new error with additional context.

This allows wrapping an existing error with additional information while preserving the original error details.

pub fn with_parsing_context<S>(self, context: S, _span: Span) -> Error

where S: Into<String>,

Creates a new error with a custom context message and span.

This is useful when you need to provide additional context about what was being parsed when the error occurred.

pub fn is_string_error(&self) -> bool

Checks if this error is related to string parsing.

Useful for error categorization and specialized error handling.

pub fn is_number_error(&self) -> bool

Checks if this error is related to number parsing.

Useful for error categorization and specialized error handling.

pub fn is_structural_error(&self) -> bool

Checks if this error is a structural parsing error.

Structural errors include bracket mismatches, unexpected tokens, etc.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 ErrorUtils for Error

fn position(&self) -> Option<usize>

Returns the position in the input where the error occurred, if available.

fn is_string_error(&self) -> bool

Checks if this error is related to string parsing.

fn is_number_error(&self) -> bool

Checks if this error is related to number parsing.

fn is_structural_error(&self) -> bool

Checks if this error is a structural parsing error.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error