Struct ValidationError

pub struct ValidationError {
    pub field: String,
    pub message: String,
}

Represents an error that occurs during validation of a struct’s field.

Each ValidationError contains the name of the field that failed validation and an associated error message explaining the reason for the failure.

Fields

field: String

message: String

Implementations

impl ValidationError

pub fn new(field: &str, message: &str) -> Self

Creates a new ValidationError for a specific field with a given message.

Arguments

• field - The name of the field that failed validation.
• message - A description of the validation error.

Examples

use struct_validation_core::ValidationError;

let error = ValidationError::new("username", "must not be empty");
assert_eq!(error.field, "username");
assert_eq!(error.message, "must not be empty");

pub fn add_prefix(&mut self, prefix: &str)

Adds a prefix to the field name, separated by a dot.

This can be useful for nested validation errors where the field is part of a larger struct.

Arguments

• prefix - The prefix to add to the field name.

Examples

use struct_validation_core::ValidationError;

let mut error = ValidationError::new("username", "must not be empty");
error.add_prefix("user");
assert_eq!(error.field, "user.username");

Trait Implementations

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Diagnostic for ValidationError

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for ValidationError

fn fmt(&self, __formatter: &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.