Struct JsonDecodeError

Source

pub struct JsonDecodeError<R = JsonResource, Q = usize>where
    Q: Copy + Debug,
{ /* private fields */ }

Expand description

Failure produced by either strict or normalizing JSON decoding.

Internal variants are private so callers branch through stable semantic accessors rather than depending on scanner, normalizer, or Serde details.

§Type Parameters

R - Resource identity attached to budget failures.
Q - Quantity representation attached to budget failures.

§Examples

use qubit_json::decode::{JsonDecodeError, JsonDecodeErrorKind, JsonDecoder};
use serde_json::Value;

let mut decoder = JsonDecoder::unlimited();
let error: JsonDecodeError = decoder
    .decode_str::<Value>("")
    .expect_err("empty input must be rejected");
assert_eq!(error.kind(), JsonDecodeErrorKind::InvalidJson);

Implementations§

Source §

impl<R, Q> JsonDecodeError<R, Q>
where Q: Copy + Debug,

Source

pub const fn kind(&self) -> JsonDecodeErrorKind

Returns the stable failure category.

§Returns

The category describing which kind of decode operation failed.

Source

pub const fn stage(&self) -> JsonDecodeStage

Returns the semantic stage that produced the failure.

§Returns

The pipeline stage at which the failure was recorded.

Source

pub const fn diagnostic_policy(&self) -> DiagnosticPolicy

Returns the diagnostic policy applied while constructing this error.

§Returns

The policy that determines whether input-derived details are retained.

Source

pub const fn raw_input_bytes(&self) -> usize

Returns the original input length in bytes.

§Returns

The number of bytes charged for the input that caused this error.

Source

pub const fn normalized_input_bytes(&self) -> Option<usize>

Returns the normalized text length when normalization completed.

§Returns

Some(length) when normalization produced text, or None when the failure occurred before a normalized document existed.

Source

pub const fn line(&self) -> Option<usize>

Returns the one-based error line when available.

§Returns

Some(line) for failures with source coordinates, otherwise None.

Source

pub const fn column(&self) -> Option<usize>

Returns the one-based error column when available.

§Returns

Some(column) for failures with source coordinates, otherwise None.

Source

pub const fn syntax_error(&self) -> Option<&JsonSyntaxError>

Returns the structured syntax failure for invalid JSON.

§Returns

A borrowed syntax error when parsing failed, otherwise None.

Source

pub const fn budget_error(&self) -> Option<&MeasuredBudgetError<R, Q>>

Returns the complete measured-budget failure when present.

§Returns

A borrowed budget error when resource accounting rejected the input, otherwise None.

Source

pub const fn utf8_valid_up_to(&self) -> Option<usize>

Returns the valid UTF-8 prefix length for invalid byte input.

§Returns

Some(bytes) for an invalid UTF-8 failure, or None for other failure kinds.

Source

pub const fn utf8_error_len(&self) -> Option<usize>

Returns the invalid UTF-8 sequence length when known.

§Returns

The length of the invalid sequence when the decoder can determine it, otherwise None.

Source

pub const fn expected_top_level(&self) -> Option<JsonRootKind>

Returns the expected top-level kind for a constrained decode failure.

§Returns

The required root kind when a constrained operation failed, otherwise None.

Source

pub const fn actual_top_level(&self) -> Option<JsonRootKind>

Returns the observed top-level kind for a constrained decode failure.

§Returns

The root kind observed in the valid document, otherwise None.

Source

pub fn into_source(self) -> JsonDecodeErrorSource<R, Q>

Consumes this error and returns its owned semantic source.

Unlike the kind-specific accessors, this operation preserves the complete mutually exclusive failure state. Input-derived third-party sources remain present only when the decoder used DiagnosticPolicy::Detailed.