Enum Error 

#[non_exhaustive]
pub enum Error {
    Syntax {
        offset: usize,
        reason: &'static str,
    },
    TrailingContent {
        offset: usize,
    },
    DuplicateMember {
        name: String,
        offset: usize,
    },
    StringNotScalar {
        offset: usize,
        reason: &'static str,
    },
    UnsafeInteger {
        token: String,
    },
    NonIntegerNumber {
        token: String,
    },
    NonFiniteNumber {
        token: String,
    },
    TooDeep {
        limit: usize,
        offset: usize,
    },
    Canonicalization {
        detail: String,
    },
    TooLarge {
        len: usize,
        limit: usize,
    },
}

Why a document was refused.

Every variant is a refusal, never a repair. A canonicalizer that repairs its input produces bytes two parties can disagree about, which is the whole failure canonicalization exists to remove.

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.

Syntax

The bytes are not one syntactically valid JSON value.

Fields

offset: usize

Byte offset where the scan stopped.

reason: &'static str

What the parser expected there.

TrailingContent

A complete JSON value was followed by something other than whitespace.

Fields

offset: usize

Byte offset of the first unexpected byte.

DuplicateMember

An object repeated a member name.

Collapsing a repeat to last-wins is a split-view attack: two parties read the same bytes as two different documents, and a signature over either reading verifies.

Fields

name: String

The repeated member name.

offset: usize

Byte offset of the repeated name’s opening quote.

StringNotScalar

A string literal’s bytes do not denote a sequence of Unicode scalar values: an unpaired surrogate escape, a surrogate escape pair that is not high-then-low, a raw control character, invalid UTF-8 (which includes an overlong form and a surrogate encoded directly in UTF-8), or, under the I-JSON profile, a Unicode noncharacter.

The check runs on the raw bytes before any decode, because a decoder cannot report it afterwards: a decoder that substitutes U+FFFD leaves three distinct wire strings canonicalizing to identical bytes.

Fields

offset: usize

Byte offset inside the document.

reason: &'static str

Which fault was found.

UnsafeInteger

An integer outside the range where an IEEE-754 double is exact, refused under the I-JSON safe-integer profile.

Fields

token: String

The offending number token, as written.

NonIntegerNumber

A number with a fractional part, refused under the integers-only tightening of the I-JSON profile.

Fields

token: String

The offending number token, as written.

NonFiniteNumber

A number token whose value is not finite as an IEEE-754 double, so RFC 8785 has no serialization for it.

Fields

token: String

The offending number token, as written.

TooDeep

Nesting exceeded the configured depth cap.

The cap refuses rather than recursing. Without it a crafted document overflows the stack, which is not catchable and happens before any signature is checked.

Fields

limit: usize

The cap that was exceeded.

offset: usize

Byte offset of the container that would have crossed it.

Canonicalization

The delegate refused to serialize a document this crate admitted.

Unreachable for an admitted document, and present rather than a panic: serde_json_canonicalizer returns a serde_json::Error that is neither Clone nor Eq, so it is carried as its rendered text. A caller that sees this variant is looking at a disagreement between the admission layer and the canonicalizer, which is a defect in one of them and not a statement about the input.

Fields

detail: String

What the delegate reported, rendered.

TooLarge

The input exceeded the configured size cap.

A depth cap bounds the stack; a size cap bounds the heap. Both are needed, because a depth limit alone leaves memory use proportional to input length.

Fields

len: usize

Input length in bytes.

limit: usize

The cap that was exceeded.

Trait Implementations

impl Clone for Error

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 Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error