Skip to main content

Error

Struct Error 

Source
pub struct Error { /* private fields */ }
Expand description

Why a document was rejected, and where.

Every error carries the byte offset of the first byte that made the input invalid. For a syntax error that is the first byte at which the input stops being the beginning of any valid JSON text, so the offset points at the mistake itself, not at the start of the value that contains it. When the input ends too early the offset is the input’s length.

A few errors point at a byte that starts something larger: a lone surrogate at the backslash of its \u escape, a duplicate key at the opening quote of its second occurrence, and the budget errors at the start of the value that exceeded the budget. ErrorKind says which applies.

§Examples

use jsonx_lib::{parse, ErrorKind};

let err = parse(r#"{"a": 1,}"#).unwrap_err();
assert_eq!(err.kind(), ErrorKind::TrailingComma);
assert_eq!(err.offset(), 8);
assert_eq!(err.to_string(), "trailing comma before `}` or `]` at byte 8");

Implementations§

Source§

impl Error

Source

pub const fn kind(&self) -> ErrorKind

What went wrong.

§Examples
use jsonx_lib::{parse, ErrorKind};

assert_eq!(parse("[1 2]").unwrap_err().kind(), ErrorKind::ExpectedCommaOrBracket);
Source

pub const fn offset(&self) -> usize

The byte offset into the input where the error was found.

§Examples
use jsonx_lib::parse;

// The `x` is the first byte that cannot continue `tru`.
assert_eq!(parse("[tru x]").unwrap_err().offset(), 4);
Source§

impl Error

Source

pub fn line_col(&self, input: impl AsRef<[u8]>) -> (usize, usize)

The error’s line and column in input (the text that was parsed), both counted from 1, the column in characters: for a message a person reads. A line ends at \n, \r\n, or \r.

§Examples
let text = "{\n  \"a\": tru\n}";
let err = jsonx_lib::parse(text).unwrap_err();
assert_eq!(err.line_col(text), (2, 11));
Source

pub fn utf16_position(&self, input: impl AsRef<[u8]>) -> (usize, usize)

The error’s position in input as the Language Server Protocol counts it: line and character from 0, the character in UTF-16 code units (a character above U+FFFF counts two). A line ends at \n, \r\n, or \r.

§Examples
let text = "[\"\u{1f600}\", tru]";
let err = jsonx_lib::parse(text).unwrap_err();
assert_eq!(err.offset(), 12);
assert_eq!(err.utf16_position(text), (0, 10)); // the emoji is two units

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Self

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 DecodeError

Source§

fn from(e: Error) -> Self

Converts to this type from the input type.
Source§

impl Hash for Error

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Error

Source§

fn eq(&self, other: &Self) -> 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 Forget for Error

§

impl Freeze for Error

§

impl Move 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.