Enum JsonToolsError 

#[non_exhaustive]
pub enum JsonToolsError {
    JsonParseError {
        message: String,
        suggestion: String,
        source: JsonError,
    },
    RegexError {
        message: String,
        suggestion: String,
        source: Error,
    },
    InvalidReplacementPattern {
        message: String,
        suggestion: String,
    },
    InvalidJsonStructure {
        message: String,
        suggestion: String,
    },
    ConfigurationError {
        message: String,
        suggestion: String,
    },
    BatchProcessingError {
        index: usize,
        message: String,
        suggestion: String,
        source: Box<JsonToolsError>,
    },
    InputValidationError {
        message: String,
        suggestion: String,
    },
    SerializationError {
        message: String,
        suggestion: String,
        source: JsonError,
    },
}

Comprehensive error type for all JSON Tools operations with detailed information and suggestions

Each error variant includes:

• Machine-readable error code (E001-E008) for programmatic handling
• Human-readable message
• Actionable suggestion
• Source error (where applicable)

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.

JsonParseError

Error parsing JSON input with detailed context and suggestions

Fields

message: String

suggestion: String

source: JsonError

RegexError

Error compiling or using regex patterns with helpful suggestions

Fields

message: String

suggestion: String

source: Error

InvalidReplacementPattern

Invalid replacement pattern configuration with detailed guidance

Fields

message: String

suggestion: String

InvalidJsonStructure

Invalid JSON structure for the requested operation

Fields

message: String

suggestion: String

ConfigurationError

Configuration error when operation mode is not set

Fields

message: String

suggestion: String

BatchProcessingError

Error processing batch item with detailed context

Fields

index: usize

message: String

suggestion: String

source: Box<JsonToolsError>

InputValidationError

Input validation error with helpful guidance

Fields

message: String

suggestion: String

SerializationError

Serialization error when converting results back to JSON

Fields

message: String

suggestion: String

source: JsonError

Implementations

impl JsonToolsError

pub fn error_code(&self) -> &'static str

Get machine-readable error code for programmatic handling

Examples

use json_tools_rs::{JSONTools, JsonToolsError};

let result = JSONTools::new().flatten().execute("invalid json");
if let Err(e) = result {
    match e.error_code() {
        "E001" => println!("JSON parsing error"),
        "E005" => println!("Configuration error"),
        _ => println!("Other error"),
    }
}

pub fn json_parse_error(source: JsonError) -> Self

Create a JSON parse error with helpful suggestions

pub fn regex_error(source: Error) -> Self

Create a regex error with helpful suggestions

pub fn invalid_replacement_pattern(message: impl Into<String>) -> Self

Create an invalid replacement pattern error

pub fn invalid_json_structure(message: impl Into<String>) -> Self

Create an invalid JSON structure error

pub fn configuration_error(message: impl Into<String>) -> Self

Create a configuration error

pub fn batch_processing_error(index: usize, source: JsonToolsError) -> Self

Create a batch processing error

pub fn input_validation_error(message: impl Into<String>) -> Self

Create an input validation error

pub fn serialization_error(source: JsonError) -> Self

Create a serialization error

Trait Implementations

impl Debug for JsonToolsError

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

Formats the value using the given formatter.

impl Display for JsonToolsError

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

Formats the value using the given formatter.

impl Error for JsonToolsError

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.

impl From<Error> for JsonToolsError

fn from(error: JsonError) -> Self

Converts to this type from the input type.

impl From<Error> for JsonToolsError

fn from(error: Error) -> Self

Converts to this type from the input type.