Struct JsonSyntaxError 

pub struct JsonSyntaxError { /* private fields */ }

A JSON syntax error with a zero-based byte offset and one-based source coordinates. Its column counts UTF-8 characters; CRLF is one line break, while LF and standalone CR each also start a new line.

Examples

use qubit_json::decode::{JsonSyntaxError, JsonSyntaxErrorReason};

let error = JsonSyntaxError::new(
    0,
    1,
    1,
    JsonSyntaxErrorReason::UnexpectedEnd,
);
assert_eq!(error.line(), 1);
assert_eq!(error.reason(), JsonSyntaxErrorReason::UnexpectedEnd);

Implementations

impl JsonSyntaxError

pub const fn new( offset: usize, line: usize, column: usize, reason: JsonSyntaxErrorReason, ) -> Self

Creates a syntax error from a source position and stable reason.

Parameters

• offset - Zero-based byte offset at which the error was observed.
• line - One-based source line containing the error.
• column - One-based UTF-8 character column containing the error.
• reason - Stable classification of the lexical failure.

Returns

A syntax error containing the supplied location and classification.

pub const fn context(&self) -> Option<JsonDecodeContext>

Returns the grammar location where the error occurred, when known.

pub const fn offset(&self) -> usize

Returns the zero-based byte offset.

Returns

The zero-based byte offset at which the error was observed.

pub const fn line(&self) -> usize

Returns the one-based source line.

Returns

The one-based source line containing the error.

pub const fn column(&self) -> usize

Returns the one-based UTF-8 character column.

Returns

The one-based UTF-8 character column containing the error.

pub const fn reason(&self) -> JsonSyntaxErrorReason

Returns the stable syntax classification.

Returns

The stable lexical failure classification.

pub const fn with_context(self, context: JsonDecodeContext) -> Self

Returns this error with the supplied grammar context.

Parameters

• context - Grammar location associated with this syntax error.

Trait Implementations

impl Clone for JsonSyntaxError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JsonSyntaxError

impl Debug for JsonSyntaxError

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

Formats the value using the given formatter.

impl Display for JsonSyntaxError

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

Formats the reason and complete source location for human-readable diagnostics.

Parameters

• formatter - Destination that receives the human-readable diagnostic.

Errors

Returns the formatter’s error if writing the diagnostic to its output fails.

impl Eq for JsonSyntaxError

impl Error for JsonSyntaxError

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 JsonSyntaxError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JsonSyntaxError