Enum ValidationResult 

pub enum ValidationResult {
    Passed,
    Failed {
        message: String,
        violations: Vec<String>,
    },
    Warning {
        message: String,
        underlying: Box<Self>,
    },
}

The outcome of validating a value against a parameter or constraint.

See SRD-0004 §ValidationResult. The Warning variant is flattened by construction (never Warning { underlying: Warning { .. } }); callers should use Self::warn rather than constructing the variant directly.

Variants

Passed

The value passed all checks.

Failed

The value failed at least one check.

Fields

message: String

High-level summary of the failure.

violations: Vec<String>

Per-check violation messages (in encounter order).

Warning

The value is acceptable but worth flagging. Exactly one level of warning may wrap an inner result.

Fields

message: String

High-level summary of the warning.

underlying: Box<Self>

The wrapped result (never itself a Warning).

Implementations

impl ValidationResult

pub const fn passed() -> Self

Construct a passing result. Provided for symmetry with the other constructors.

pub fn failed(message: impl Into<String>, violations: Vec<String>) -> Self

Construct a failing result.

pub fn warn(message: impl Into<String>, inner: Self) -> Self

Wrap an inner result with a warning. Flattens nested warnings.

If inner is itself a Warning, its own inner result is lifted so the returned value has exactly one warning layer. Messages from discarded inner warnings are lost; use the outer message to carry anything the caller needs to preserve.

pub fn is_passed(&self) -> bool

true when the effective outcome is a pass (either Passed or a warning whose underlying result is Passed).

pub fn is_failed(&self) -> bool

true when the effective outcome is a failure.

pub fn violations(&self) -> &[String]

Borrow the violation list, if any. Descends one level of warning.

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

Borrow the top-level summary message, if any.

Trait Implementations

impl Clone for ValidationResult

fn clone(&self) -> ValidationResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValidationResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ValidationResult

fn eq(&self, other: &ValidationResult) -> 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 Serialize for ValidationResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ValidationResult

impl StructuralPartialEq for ValidationResult