Struct JsonDecodeError 

#[non_exhaustive]
pub struct JsonDecodeError { /* private fields */ }

Error returned when lenient JSON decoding fails.

This type exposes immutable diagnostics so its error category, stage, and associated input metadata always remain consistent with one another.

Implementations

impl JsonDecodeError

pub const fn kind(&self) -> JsonDecodeErrorKind

Returns the stable category of this decoding failure.

Returns

The stable error category.

pub const fn stage(&self) -> JsonDecodeStage

Returns the decoding stage that produced this error.

Returns

The decoder stage where the failure occurred.

pub const fn privacy_policy(&self) -> ErrorPrivacyPolicy

Returns the privacy policy applied when this error was constructed.

Returns

The effective error privacy policy.

pub fn message(&self) -> &str

Returns the human-readable diagnostic message.

Returns

The stable redacted message or explicitly requested detailed message.

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

Returns the required top-level JSON kind for a constrained decode.

Returns

Some(kind) when constrained decoding rejected a valid top-level value; otherwise, None.

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

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

Returns

Some(kind) when constrained decoding rejected a valid top-level value; otherwise, None.

pub const fn raw_input_bytes(&self) -> usize

Returns the byte length of the input before normalization.

Returns

The raw input length in bytes.

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

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

Returns

Some(length) for JsonDecodeErrorKind::InvalidUtf8, including zero when the first byte is invalid; otherwise, None.

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

Returns the known length of the invalid UTF-8 sequence.

Returns

Some(length) when the invalid sequence length is known, or None for an incomplete trailing sequence and for non-UTF-8 errors.

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

Returns the byte length of normalized JSON text.

Returns

Some(length) when normalization completed before the failure, or None when the input was rejected before a normalized length existed.

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

Returns the configured raw-input limit for a size failure.

Returns

Some(limit) when raw input exceeded its configured limit, or None for normalized-size and non-size failures.

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

Returns the configured normalized-input limit for a size failure.

Returns

Some(limit) when normalized JSON exceeded its configured limit, or None for raw-size and non-size failures.

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

Returns the parser line in normalized JSON text.

Returns

Some(line) with a one-based line number when serde reported one, or None when no parser location is available.

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

Returns the parser column in normalized JSON text.

Returns

Some(column) with a one-based column number when serde reported one, or None when no parser location is available.

Trait Implementations

impl Clone for JsonDecodeError

fn clone(&self) -> JsonDecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonDecodeError

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

Formats the value using the given formatter.

impl Display for JsonDecodeError

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

Writes the configured human-readable diagnostic message.

Parameters

• f - Destination formatter.

Returns

Ok(()) when the message is written successfully.

Errors

Returns a formatting error when the destination formatter rejects the write.

impl Eq for JsonDecodeError

impl Error for JsonDecodeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the decoder source under detailed privacy mode.

Returns

Some(source) when detailed diagnostics expose a UTF-8 or serde error, or None for redacted and source-free failures.

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 JsonDecodeError

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

Compares all stable error fields while ignoring the retained source.

Parameters

• other - Error to compare with this error.

Returns

true when every stable diagnostic field is equal; otherwise, false.

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

Inequality operator !=.