Enum MetadataWireDecodeError 

#[non_exhaustive]
pub enum MetadataWireDecodeError {
    Read {
        kind: ErrorKind,
        source: Option<Arc<Error>>,
    },
    Domain(MetadataError),
    UnsupportedVersion {
        expected: u8,
        actual: u8,
    },
    Budget(BudgetError<JsonResource, usize>),
    Quantity {
        resource: JsonResource,
        source: QuantityConversionError,
    },
    Syntax(JsonSyntaxError),
    InvalidLimits(Error),
    Filter(MetadataError),
    InvalidJson(Error),
    Decode(JsonDecodeError<JsonResource>),
}

Failure returned by a bounded metadata JSON decoding API.

Examples

use qubit_metadata::Metadata;

let error = Metadata::decode_json_slice(b"not-json").unwrap_err();
assert!(!error.to_string().is_empty());

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.

Read

Reading the JSON wire input failed.

Fields

kind: ErrorKind

Stable standard I/O failure category.

source: Option<Arc<Error>>

Original error retained for detailed diagnostics.

Domain(MetadataError)

A metadata map or schema exceeded a domain limit without exposing values.

Tuple Fields

0: MetadataError

Structured metadata-domain failure.

UnsupportedVersion

The envelope requests a wire version this decoder does not support.

Fields

expected: u8

Version supported by this decoder.

actual: u8

Version present in the envelope.

Budget(BudgetError<JsonResource, usize>)

The JSON document exceeded one shared budget limit.

Tuple Fields

0: BudgetError<JsonResource, usize>

Shared JSON budget that was exceeded.

Quantity

A native JSON measurement could not be represented by the budget quantity.

Fields

resource: JsonResource

Resource whose measurement failed to convert.

source: QuantityConversionError

Conversion failure retaining the original measurement and target type.

Syntax(JsonSyntaxError)

The JSON lexical preflight rejected the document with source details.

Tuple Fields

0: JsonSyntaxError

Lexical JSON syntax failure.

InvalidLimits(Error)

The caller supplied metadata limits outside the protocol hard caps.

Tuple Fields

0: Error

Validation error for the supplied metadata limits.

Filter(MetadataError)

A decoded metadata-filter envelope violated its structured contract.

Tuple Fields

0: MetadataError

Structured filter-contract failure.

InvalidJson(Error)

A materialized metadata wire value could not be converted to a scalar metadata value.

Tuple Fields

0: Error

The original serde_json error.

Decode(JsonDecodeError<JsonResource>)

A shared decoding failure retaining its structured facts and diagnostic policy.

Tuple Fields

0: JsonDecodeError<JsonResource>

Shared JSON decoding failure.

Trait Implementations

impl Debug for MetadataWireDecodeError

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

Formats the value using the given formatter.

impl Display for MetadataWireDecodeError

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

Formats a bounded JSON decoding failure.

Parameters

• formatter - Formatter receiving the error message.

Returns

A formatting result indicating whether the message was written.

impl Error for MetadataWireDecodeError

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

Returns the retained source error associated with this failure.

Returns

Returns Some for failures that retain an underlying source, including detailed read failures, domain, budget, quantity, syntax, Serde, and optional filter failures. Returns None for unsupported wire versions and read failures whose diagnostic policy did not retain the original I/O error.

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 From<JsonDecodeError> for MetadataWireDecodeError

fn from(error: JsonDecodeError<JsonResource>) -> Self

Converts a shared JSON decoding error into a metadata wire error.

Parameters

• error - Shared JSON decoding failure to convert.

Returns

The corresponding metadata wire decoding error.