Struct ValidationError 

pub struct ValidationError { /* private fields */ }

A structured validation error that tracks the config key path.

Implementations

impl ValidationError

pub fn new(key_path: impl Into<String>, message: impl Into<String>) -> Self

Create a new validation error for a config key.

pub fn with_file(self, path: impl Into<PathBuf>) -> Self

Add a file path to the error.

pub fn with_line(self, line: usize) -> Self

Add a line number to the error.

pub fn with_suggestion(self, suggestion: impl Into<String>) -> Self

Add a suggested fix to the error.

pub fn key_path(&self) -> &str

Get the config key path.

pub fn message(&self) -> &str

Get the error message.

pub fn file_path(&self) -> Option<&Path>

Get the file path, if available.

pub fn line(&self) -> Option<usize>

Get the line number, if available.

pub fn suggestion(&self) -> Option<&str>

Get the suggested fix, if available.

pub fn unknown_scope(value: &str) -> Self

Create a validation error for an unknown scope value.

pub fn unknown_severity(check_id: &str, value: &str) -> Self

Create a validation error for an unknown severity value.

pub fn unknown_fail_on(value: &str) -> Self

Create a validation error for an unknown fail_on value.

pub fn unknown_profile(value: &str) -> Self

Create a validation error for an unknown profile value.

pub fn invalid_allow_glob(check_id: &str, pattern: &str, error: &str) -> Self

Create a validation error for an invalid glob pattern in an allowlist.

pub fn unknown_check_id(check_id: &str) -> Self

Create a validation error for an unknown check ID.

pub fn invalid_max_findings(value: u32) -> Self

Create a validation error for an invalid max_findings value.

pub fn ignore_publish_false_not_supported(check_id: &str) -> Self

Create a validation error for ignore_publish_false on an unsupported check.

pub fn invalid_boolean(key_path: &str, value: &str) -> Self

Create a validation error for an invalid boolean value.

pub fn invalid_integer(key_path: &str, value: &str) -> Self

Create a validation error for an invalid integer value.

pub fn missing_required_field(key_path: &str) -> Self

Create a validation error for a missing required field.

pub fn invalid_enum_value( key_path: &str, value: &str, expected: &[&str], ) -> Self

Create a validation error for an invalid enum value with custom expected values.

Trait Implementations

impl Clone for ValidationError

fn clone(&self) -> ValidationError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Display for ValidationError

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<ValidationError> for ValidationErrors

fn from(error: ValidationError) -> Self

Converts to this type from the input type.

impl PartialEq for ValidationError

fn eq(&self, other: &ValidationError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ValidationError