Skip to main content

ValueWireJsonError

Struct ValueWireJsonError 

Source
pub struct ValueWireJsonError { /* private fields */ }
Available on crate feature json only.
Expand description

Privacy-safe classification and source position for a JSON wire failure.

Obtain this metadata from ValueWireDecodeError::InvalidJson rather than constructing it directly. It contains only the Serde category and source coordinates; it does not retain the input or detailed error message. A coordinate of zero means that the source position is unavailable, as can happen for target-type failures after decoding through a unique-key tree. Direct conversion from a Serde error preserves its source coordinates.

§Examples

use qubit_value::ValueWireDecodeError;
use qubit_value::ValueWireJsonError;
use serde_json::error::Category;

fn check_metadata(metadata: &ValueWireJsonError) {
    assert_eq!(metadata.classify(), Category::Data);
    assert!(metadata.is_data());
    assert!(metadata.line() > 0);
    assert!(metadata.column() > 0);
}

let source = serde_json::from_str::<u64>(r#""not a number""#).unwrap_err();
let error = ValueWireDecodeError::from(source);
let ValueWireDecodeError::InvalidJson(metadata) = error else {
    panic!("direct Serde conversion must preserve safe metadata");
};
check_metadata(&metadata);

Implementations§

Source§

impl ValueWireJsonError

Source

pub fn classify(&self) -> Category

Returns the Serde JSON failure category.

§Returns

The category associated with the failure.

Source

pub fn line(&self) -> usize

Returns the one-based input line, or zero when unavailable.

§Returns

The source line, or zero if no source position is available.

Source

pub fn column(&self) -> usize

Returns the one-based input column, or zero when unavailable.

§Returns

The source column, or zero if no source position is available.

Source

pub fn is_io(&self) -> bool

Returns whether the error is an I/O failure.

§Returns

true if the category is Category::Io; otherwise, false.

Source

pub fn is_syntax(&self) -> bool

Returns whether the error is a JSON syntax failure.

§Returns

true if the category is Category::Syntax; otherwise, false.

Source

pub fn is_data(&self) -> bool

Returns whether the JSON data has an incompatible type or value.

§Returns

true if the category is Category::Data; otherwise, false.

Source

pub fn is_eof(&self) -> bool

Returns whether the JSON input ended before decoding completed.

§Returns

true if the category is Category::Eof; otherwise, false.

Trait Implementations§

Source§

impl Debug for ValueWireJsonError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ValueWireJsonError

Source§

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

Writes the failure category and coordinates without exposing input data.

§Parameters
  • formatter: Destination for the privacy-safe diagnostic.
§Returns

Success after writing the diagnostic.

§Errors

Returns the destination’s formatting error if writing fails.

Source§

impl Error for ValueWireJsonError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoValueDefault<T> for T

Source§

fn into_value_default(self) -> T

Returns the owned value unchanged as the default.

§Returns

The input value, moved without cloning.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.