Struct JsonSerializationError 

pub struct JsonSerializationError { /* private fields */ }

Privacy-safe failure produced while serializing a value as strict JSON.

The error exposes exact stable kinds and broad handling categories without retaining input values, object keys, or arbitrary third-party diagnostics.

Examples

use qubit_json::encode::JsonIntegerSignedness;
use qubit_json::encode::JsonSerializationErrorKind;
use qubit_json::value::JsonValueEncoder;

let error = JsonValueEncoder::new()
    .encode(&u128::MAX)
    .expect_err("wide integer must be rejected");
assert_eq!(
    error.kind(),
    JsonSerializationErrorKind::IntegerOutOfRange {
        signedness: JsonIntegerSignedness::Unsigned,
    },
);

Implementations

impl JsonSerializationError

pub const fn new(kind: JsonSerializationErrorKind) -> Self

Creates an error from its stable public kind.

Parameters

• kind - Exact privacy-safe serialization failure.

Returns

A serialization error retaining only kind.

pub const fn kind(&self) -> JsonSerializationErrorKind

Returns the exact stable failure classification.

Returns

The precise serialization failure kind retained by this error.

pub const fn category(&self) -> JsonSerializationErrorCategory

Returns the broad downstream handling category.

Returns

The broad category that determines which class of serialization failure occurred.

pub const fn is_number_error(&self) -> bool

Reports whether this failure belongs to the strict number contract.

Returns

true when the failure concerns a JSON number; otherwise, false.

pub const fn is_map_key_error(&self) -> bool

Reports whether this failure concerns JSON object-key representation.

Returns

true when the failure concerns an object key; otherwise, false.

pub const fn is_raw_value_error(&self) -> bool

Reports whether this failure concerns a RawValue payload.

Returns

true when the failure concerns a RawValue payload; otherwise, false.

pub const fn is_serializer_contract_error(&self) -> bool

Reports whether a hand-written serializer violated a protocol contract.

Returns

true when a serializer or display implementation violated the compound protocol; otherwise, false.

pub const fn integer_signedness(&self) -> Option<JsonIntegerSignedness>

Returns the signedness of an out-of-range integer, when applicable.

Returns

Some(signedness) for an out-of-range integer, or None for every other serialization failure.

pub const fn map_key_kind(&self) -> Option<JsonMapKeyKind>

Returns the rejected map-key shape, when applicable.

Returns

Some(kind) for an unsupported map key, or None for every other serialization failure.

pub const fn collection_kind(&self) -> Option<JsonCollectionKind>

Returns the collection whose count overflowed, when applicable.

Returns

Some(kind) for a collection-length overflow, or None for every other serialization failure.

pub const fn serializer_state_error(&self) -> Option<JsonSerializerStateError>

Returns the exact invalid serializer state, when applicable.

Returns

Some(reason) for an invalid serializer state, or None for every other serialization failure.

Trait Implementations

impl Clone for JsonSerializationError

fn clone(&self) -> JsonSerializationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JsonSerializationError

impl Debug for JsonSerializationError

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

Formats the value using the given formatter.

impl Display for JsonSerializationError

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

Formats the value using the given formatter.

impl Eq for JsonSerializationError

impl Error for JsonSerializationError

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

fn custom<T>(_message: T) -> Self

where T: Display,

Converts arbitrary custom serializer text into one opaque, stable kind.

impl Hash for JsonSerializationError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for JsonSerializationError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JsonSerializationError