Struct ValidationError 

pub struct ValidationError<'a> { /* private fields */ }

An error that can occur during validation.

Implementations

impl<'a> ValidationError<'a>

Shortcuts for creation of specific error kinds.

pub fn instance(&self) -> &Cow<'a, Value>

Returns a reference to the instance that failed validation.

pub fn kind(&self) -> &ValidationErrorKind

Returns the kind of validation error.

pub fn instance_path(&self) -> &Location

Returns the JSON Pointer to the instance location that failed validation.

pub fn schema_path(&self) -> &Location

Returns the canonical schema location without $ref traversals.

This corresponds to JSON Schema’s “keywordLocation” in output formats. See JSON Schema 2020-12 Core, Section 12.4.2.

pub fn evaluation_path(&self) -> &Location

Returns the dynamic evaluation path including $ref traversals.

This corresponds to JSON Schema’s “evaluationPath” - the actual path taken through the schema including by-reference applicators ($ref, $dynamicRef). See JSON Schema 2020-12 Core, Section 12.4.2.

pub fn absolute_keyword_location(&self) -> Option<&Uri<String>>

Returns the absolute keyword location as a full URI including JSON Pointer fragment.

This corresponds to JSON Schema’s “absoluteKeywordLocation” (e.g. https://example.com/schema.json#/properties/name/type).

Present when the schema has a real base URI set via $id or crate::options::ValidationOptions::with_base_uri. None for schemas without an explicit base URI.

pub fn into_parts(self) -> ValidationErrorParts<'a>

Decomposes the error into its owned parts.

pub fn masked<'b>(&'b self) -> MaskedValidationError<'a, 'b, 'static>

Returns a wrapper that masks instance values in error messages. Uses “value” as a default placeholder.

pub fn masked_with<'b, 'c>( &'b self, placeholder: impl Into<Cow<'c, str>>, ) -> MaskedValidationError<'a, 'b, 'c>

Returns a wrapper that masks instance values in error messages with a custom placeholder.

pub fn to_owned(self) -> ValidationError<'static>

Converts the ValidationError into an owned version with 'static lifetime.

pub fn custom(message: impl Into<String>) -> ValidationError<'static>

Create a custom validation error with just a message.

Use this in Keyword::validate implementations. The actual instance, instance path, and schema path are filled in automatically.

Example

use jsonschema::ValidationError;

fn validate_even(n: u64) -> Result<(), ValidationError<'static>> {
    if n % 2 != 0 {
        return Err(ValidationError::custom("number must be even"));
    }
    Ok(())
}

pub fn schema(message: impl Into<String>) -> ValidationError<'static>

Create an error for invalid schema values in keyword factories.

Use this in custom keyword factory functions when the schema value is invalid for your custom keyword.

Trait Implementations

impl<'a> Debug for ValidationError<'a>

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

Formats the value using the given formatter.

impl Display for ValidationError<'_>

Textual representation of various validation errors.

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

Formats the value using the given formatter.

impl Error for ValidationError<'_>

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 ValidationError<'_>

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for ValidationError<'_>

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.