Struct JsonEncodeError

Source

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

Expand description

Failure produced while encoding one JSON document.

Internal failure variants remain private. Callers branch through JsonEncodeErrorKind and inspect sources through stable accessors rather than depending on the encoder’s representation.

§Type Parameters

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

§Examples

use qubit_json::encode::JsonEncodeErrorKind;
use qubit_json::encode::JsonEncoder;

let mut encoder = JsonEncoder::unlimited();
let error = encoder
    .to_vec(&u128::MAX)
    .expect_err("wide integer must not serialize as JSON");
assert_eq!(error.kind(), JsonEncodeErrorKind::Serialize);
assert!(error.serialization_error().is_some());

Implementations§

Source §

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

Source

pub const fn kind(&self) -> JsonEncodeErrorKind

Returns the stable failure category.

§Returns

The category describing which encoding operation failed.

Source

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

Returns the measured budget failure when accounting rejected work.

§Returns

Some with the borrowed budget error for JsonEncodeErrorKind::Budget, or None for every other failure kind.

Source

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

Returns the syntax error retained for invalid raw JSON.

§Returns

Some with the borrowed syntax error for JsonEncodeErrorKind::InvalidRawJson, or None otherwise.

Source

pub const fn serialization_error(&self) -> Option<&JsonSerializationError>

Returns the privacy-safe Serde serialization error when present.

§Returns

Some with the borrowed serialization error for JsonEncodeErrorKind::Serialize, or None otherwise.

Source

pub const fn write_error(&self) -> Option<&IoError>

Returns the destination-writer error when present.

§Returns

Some with the borrowed I/O error for JsonEncodeErrorKind::Write, or None otherwise.

Source

pub fn into_budget_error(self) -> Option<MeasuredBudgetError<R, Q>>

Consumes this error and returns its measured budget source when present.

§Returns

Some with the owned budget error for JsonEncodeErrorKind::Budget, or None otherwise.

Source

pub fn into_syntax_error(self) -> Option<JsonSyntaxError>

Consumes this error and returns its syntax source when present.

§Returns

Some with the owned syntax error for JsonEncodeErrorKind::InvalidRawJson, or None otherwise.

Source

pub fn into_serialization_error(self) -> Option<JsonSerializationError>

Consumes this error and returns its serialization source when present.

§Returns

Some with the owned serialization error for JsonEncodeErrorKind::Serialize, or None otherwise.

Source

pub fn into_write_error(self) -> Option<IoError>

Consumes this error and returns its destination-writer source when present.

§Returns

Some with the owned I/O error for JsonEncodeErrorKind::Write, or None otherwise.

Source

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

Consumes this error and returns its owned underlying source.

Unlike the kind-specific into_* methods, this operation never drops a non-matching error. Callers can exhaustively map every source with one match expression.