Skip to main content

Error

Struct Error 

Source
pub struct Error {
    pub code: ErrorCode,
    pub index: usize,
    pub key: Option<&'static str>,
}
Expand description

A parse or serialization failure, located within the input.

The location is an offset, not a copy of anything: it indexes the buffer you handed the parser, and it means nothing once that buffer is gone. A caller that converts this into its own error type and drops the input should render it first, with display_with, and carry the String. See docs/errors.md for the shape that has.

Fields§

§code: ErrorCode

What went wrong.

§index: usize

Byte offset into the input where the failure was detected.

§key: Option<&'static str>

The key the code is about, where the crate knows one, and None where it does not.

The offset answers “where”, and for a text document read next to display_with that is usually the whole answer. It is a poor answer for a member that is not in the document, which has no position of its own, and a thin answer for BEVE, a byte offset into a binary document being nearly unreadable. So the one code that fills this in is MissingKey, whose offset is the enclosing object’s first byte and whose name is the absent key.

Every other code leaves it empty, UnknownKey and UnknownVariant included: the cursor is already wound back to the offending name, so the offset points at it and a copy here would say the same thing twice.

&'static str, so an Error still outlives the document and stays Copy. Everything nameable here is a constant of the destination type rather than a run of input bytes, which is what makes that possible.

Option rather than an empty string, which would cost nothing here – the two are the same 32 bytes, the reference being niche-packed – and would conflate two different answers. An empty key is legal JSON, so #[required] "" => field is a schema whose missing key really is named "", and Some("") says that where "" alone could not.

A hand-written reader sets it with json::Parser::set_error_key or beve::Reader::set_error_key.

use structio::ErrorCode;

#[derive(Debug, Default)]
struct Accessor { byte_offset: u32, component_type: u32 }

structio::object!(Accessor as "camelCase" {
    #[required] byte_offset,
    #[required] "type" => component_type,
});

let e = structio::from_str::<Accessor>(r#"{"type":5}"#).unwrap_err();
assert_eq!(e.code, ErrorCode::MissingKey);
// The key the document uses, not the Rust field.
assert_eq!(e.key, Some("byteOffset"));
// And the offset is the object, which is all an absent member has.
assert_eq!(e.to_string(), r#"missing object key "byteOffset" at byte 0"#);

Implementations§

Source§

impl Error

Source

pub const fn new(code: ErrorCode, index: usize) -> Self

A failure at an offset, about no key in particular.

Source

pub const fn with_key( code: ErrorCode, index: usize, key: Option<&'static str>, ) -> Self

A failure at an offset, about a key the reader named.

Option rather than &'static str, because this is what an entry point composes with json::Parser::error_key and its BEVE twin, which have a key only sometimes. See key.

Source

pub fn display_with(&self, input: &str) -> String

Render the failure with the surrounding input, for diagnostics.

Shows the line and column plus a caret under the offending byte, and the key where there is one.

The input is the one the offset indexes. Hand it a different document and you get a caret under an unrelated byte, which is why this is worth calling at the parse site rather than remembering the offset for later.

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Error

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Error

Source§

impl Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Eq for Error

Source§

impl Error for Error

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
Source§

impl From<Error> for StreamError

Source§

fn from(e: Error) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Error

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl UnwindSafe for Error

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.