Enum ValidationOutcome 

#[non_exhaustive]
pub enum ValidationOutcome {
    Valid,
    Invalid(Vec<Violation>),
    Skipped {
        reason: SkipReason,
        prerequisites: Vec<FailureId>,
    },
}

The observable result of executing one bound validator occurrence.

Examples

use qubit_validator::{ValidationOutcome, ValidatorId, Violation, ViolationCode};

let accepted = ValidationOutcome::valid();
let rejected = ValidationOutcome::invalid(vec![Violation::new(
    ValidatorId::new("text.required"),
    ViolationCode::new("text.blank"),
)])?;
assert!(matches!(accepted, ValidationOutcome::Valid));
assert!(matches!(rejected, ValidationOutcome::Invalid(violations) if violations.len() == 1));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Valid

Input is valid.

Invalid(Vec<Violation>)

Input is invalid.

Tuple Fields

0: Vec<Violation>

One or more safe violations carrying no raw rejected value.

Skipped

Execution was skipped by the caller’s orchestration policy.

Fields

reason: SkipReason

Reason for skipping.

prerequisites: Vec<FailureId>

IDs of failures already retained in the same report.

Implementations

impl ValidationOutcome

pub const fn valid() -> Self

Creates a successful validation outcome.

Returns

A valid outcome with no violations or prerequisites.

pub fn invalid( violations: Vec<Violation>, ) -> Result<Self, ValidationOutcomeError>

Creates an invalid outcome with one or more violations.

Parameters

• violations: Non-empty safe violations produced by the validator.

Returns

An invalid outcome containing violations.

Errors

Returns ValidationOutcomeError::EmptyViolations when violations is empty.

pub fn missing_optional() -> Self

Creates an outcome skipped because the optional target is absent.

Returns

A skipped outcome with reason MissingOptional and no prerequisites.

pub fn failed_prerequisite( prerequisites: Vec<FailureId>, ) -> Result<Self, ValidationOutcomeError>

Creates an outcome skipped after at least one prerequisite failed.

Every ID must refer to a failure already retained in the report that records this outcome.

Parameters

• prerequisites: Non-empty IDs of failures retained in the report.

Returns

A skipped outcome with reason FailedPrerequisite and the supplied IDs.

Errors

Returns ValidationOutcomeError::EmptyPrerequisites when prerequisites is empty.

Trait Implementations

impl Debug for ValidationOutcome

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

Formats the value using the given formatter.

impl Eq for ValidationOutcome

impl PartialEq for ValidationOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValidationOutcome