Enum Error

pub enum Error {
    Configuration(String),
    Parse(Option<Location>, String),
    Internal(Option<Location>, String),
    TestFailure(Option<Location>, String),
}

Errors produced by the json5format library.

Variants

Configuration(String)

A formatter configuration option was invalid.

Parse(Option<Location>, String)

A syntax error was encountered while parsing a JSON5 document.

Internal(Option<Location>, String)

The parser or formatter entered an unexpected state. An Error::Internal likely indicates there is a software bug in the json5format library.

TestFailure(Option<Location>, String)

This error is only produced by internal test functions to indicate a test result did not match expectations.

Implementations

impl Error

pub fn configuration(err: impl Display) -> Self

Return a configuration error.

Arguments

• err - The error message.

pub fn parse(location: Option<Location>, err: impl Display) -> Self

Return a parsing error.

Arguments

• location - Optional location in the JSON5 document where the error was detected.
• err - The error message.

pub fn internal(location: Option<Location>, err: impl Into<String>) -> Self

Return an internal error (indicating an error in the software implementation itself).

Arguments

• location - Optional location in the JSON5 document where the error was detected, which might be available if the error occurred while parsing the document.
• err - The error message.

pub fn test_failure(location: Option<Location>, err: impl Into<String>) -> Self

Return a TestFailure error.

Arguments

• location - Optional Rust source code location where the test failed.
• err - The error message.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns the lower-level source of this error, if any.

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.