chore: Restructure ValidationError

Signed-off-by: Dmitry Dygalo <[email protected]>

Author: Stranger6667

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING**: `ValidationError` fields are private; use `instance()`, `kind()`, `instance_path()`, and `schema_path()` instead of accessing struct fields directly.
+
+### Performance
+
+- `validate` and other APIs returning `Result<_, ValidationError>` are 5–10% faster in some workloads due to the smaller error handle.
+
 ## [0.36.0] - 2025-11-18
 
 ### Added

MIGRATION.md

@@ -1,5 +1,18 @@
 # Migration Guide
 
+## Upgrading from 0.36.x to 0.37.0
+
+### `ValidationError` is now opaque
+
+All `ValidationError` fields are private. Replace `error.instance`, `error.instance_path`, `error.schema_path`, and `error.kind` with the corresponding accessor calls:
+
+```rust
+let instance = error.instance();
+let kind = error.kind();
+let instance_path = error.instance_path();
+let schema_path = error.schema_path();
+```
+
 ## Upgrading from 0.35.x to 0.36.0
 
 ### Removal of `Validator::apply`, `Output`, and `BasicOutput`

README.md

@@ -28,7 +28,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Iterate over errors
     for error in validator.iter_errors(&instance) {
         eprintln!("Error: {error}");
-        eprintln!("Location: {}", error.instance_path);
+        eprintln!("Location: {}", error.instance_path());
     }
 
     // Boolean result

crates/jsonschema-py/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Performance
+
+- `jsonschema_rs.validate()` and `Validator.validate()` run 5–10% faster in some workloads thanks to slimmer `ValidationError` objects.
+
 ## [0.36.0] - 2025-11-18
 
 ### Added

crates/jsonschema-py/src/lib.rs

@@ -467,7 +467,7 @@ impl ValidationErrorKind {
 
 fn convert_validation_context(
     py: Python<'_>,
-    context: Vec<Vec<jsonschema::error::ValidationError>>,
+    context: Vec<Vec<jsonschema::error::ValidationError<'static>>>,
     mask: Option<&str>,
 ) -> PyResult<Py<PyList>> {
     let mut py_context: Vec<Py<PyList>> = Vec::with_capacity(context.len());
@@ -532,26 +532,25 @@ fn into_validation_error_args(
         error.to_string()
     };
     let verbose_message = to_error_message(&error, message.clone(), mask);
+    let (instance, kind, instance_path, schema_path) = error.into_parts();
     let into_path = |segment: LocationSegment<'_>| match segment {
         LocationSegment::Property(property) => {
             property.into_pyobject(py).and_then(Py::<PyAny>::try_from)
         }
         LocationSegment::Index(idx) => idx.into_pyobject(py).and_then(Py::<PyAny>::try_from),
     };
-    let elements = error
-        .schema_path
+    let elements = schema_path
         .into_iter()
         .map(into_path)
         .collect::<Result<Vec<_>, _>>()?;
     let schema_path = PyList::new(py, elements)?.unbind();
-    let elements = error
-        .instance_path
+    let elements = instance_path
         .into_iter()
         .map(into_path)
         .collect::<Result<Vec<_>, _>>()?;
     let instance_path = PyList::new(py, elements)?.unbind();
-    let kind = ValidationErrorKind::try_new(py, error.kind, mask)?;
-    let instance = value_to_python(py, error.instance.as_ref())?;
+    let kind = ValidationErrorKind::try_new(py, kind, mask)?;
+    let instance = value_to_python(py, instance.as_ref())?;
     Ok((
         message,
         verbose_message,
@@ -758,7 +757,7 @@ fn to_error_message(
         }
     };
 
-    let mut schema_path = error.schema_path.as_str();
+    let mut schema_path = error.schema_path().as_str();
 
     if let Some((rest, last)) = schema_path.rsplit_once('/') {
         message.push(' ');
@@ -774,7 +773,7 @@ fn to_error_message(
     message.push('\n');
     message.push('\n');
     message.push_str("On instance");
-    for segment in error.instance_path.as_str().split('/').skip(1) {
+    for segment in error.instance_path().as_str().split('/').skip(1) {
         message.push('[');
         push_segment(&mut message, segment);
         message.push(']');
@@ -785,7 +784,7 @@ fn to_error_message(
         message.push_str(mask);
     } else {
         let mut writer = StringWriter(&mut message);
-        serde_json::to_writer(&mut writer, &error.instance).expect("Failed to serialize JSON");
+        serde_json::to_writer(&mut writer, error.instance()).expect("Failed to serialize JSON");
     }
     message
 }
@@ -1549,7 +1548,7 @@ mod meta {
         match result {
             Ok(()) => Ok(true),
             Err(error) => {
-                if let jsonschema::error::ValidationErrorKind::Referencing(err) = &error.kind {
+                if let jsonschema::error::ValidationErrorKind::Referencing(err) = error.kind() {
                     return Err(referencing_error_pyerr(py, err.to_string())?);
                 }
                 Ok(false)
@@ -1598,7 +1597,7 @@ mod meta {
         match result {
             Ok(()) => Ok(()),
             Err(error) => {
-                if let jsonschema::error::ValidationErrorKind::Referencing(err) = &error.kind {
+                if let jsonschema::error::ValidationErrorKind::Referencing(err) = error.kind() {
                     return Err(referencing_error_pyerr(py, err.to_string())?);
                 }
                 Err(crate::into_py_err(py, error, None)?)