Enum MetadataWireEncodeError 

#[non_exhaustive]
pub enum MetadataWireEncodeError {
    Budget(BudgetError<JsonResource, usize>),
    Quantity {
        resource: JsonResource,
        source: QuantityConversionError,
    },
    Syntax(JsonSyntaxError),
    Json(JsonSerializationError),
    Io(Error),
}

Failure returned by bounded metadata JSON encoding APIs.

Examples

use qubit_metadata::MetadataWireEncodeError;

let error = MetadataWireEncodeError::Io(std::io::Error::other("closed"));
assert!(error.to_string().contains("closed"));

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.

Budget(BudgetError<JsonResource, usize>)

The JSON document exceeded one configured resource budget.

Quantity

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

Fields

resource: JsonResource

Resource whose measurement failed to convert.

source: QuantityConversionError

Native measurement conversion failure.

Syntax(JsonSyntaxError)

The encoded value contains invalid JSON syntax.

Json(JsonSerializationError)

Strict JSON serialization rejected the value during bounded encoding.

Io(Error)

The destination writer rejected bounded JSON output.

Trait Implementations

impl Debug for MetadataWireEncodeError

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

Formats the value using the given formatter.

impl Display for MetadataWireEncodeError

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

Formats the encoding failure with its underlying error context.

impl Error for MetadataWireEncodeError

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

Returns the underlying budget, syntax, JSON, or 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<JsonEncodeError<JsonResource>> for MetadataWireEncodeError

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

Converts a shared budget adapter error into the metadata encoding error.

impl From<MeasuredBudgetError<JsonResource, usize>> for MetadataWireEncodeError

fn from(error: MeasuredBudgetError<JsonResource, usize>) -> Self

Converts to this type from the input type.