Enum PreparedOutcome 

#[non_exhaustive]
pub enum PreparedOutcome {
    Valid,
    Invalid(Vec<ViolationDraft>),
}

The type-erased result produced before rule identity is attached.

Examples

use qubit_validator::{PreparedOutcome, ViolationCode, ViolationDraft};

let accepted = PreparedOutcome::valid();
let rejected = PreparedOutcome::invalid(vec![
    ViolationDraft::new(ViolationCode::new("text.blank")),
])?;
assert!(matches!(accepted, PreparedOutcome::Valid));
assert!(matches!(rejected, PreparedOutcome::Invalid(drafts) if drafts.len() == 1));

The caller’s orchestration policy records missing inputs and failed prerequisites as skipped ValidationOutcome values.

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<ViolationDraft>)

Input is invalid with draft violations.

Tuple Fields

0: Vec<ViolationDraft>

One or more safe draft violations produced by the validator.

Implementations

impl PreparedOutcome

pub const fn valid() -> Self

Creates a successful prepared outcome.

Returns

A prepared outcome representing valid input.

Examples found in repository

examples/validate_named_bench.rs (line 48)

    fn validate(
        &self,
        _: ValidationValue<'_>,
        _: &BoundValidationContext<'_>,
    ) -> Result<PreparedOutcome, ExecutionError> {
        Ok(PreparedOutcome::valid())
    }

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

Creates an invalid prepared outcome with one or more violation drafts.

Parameters

• violations: Draft violations to include in the outcome.

Returns

The invalid prepared outcome containing violations.

Errors

Returns ValidationOutcomeError::EmptyViolations when violations is empty.

pub fn into_bound( self, rule_id: ValidatorId, ) -> Result<ValidationOutcome, ValidationOutcomeError>

Attaches a bound rule identity to draft violations.

Parameters

• rule_id: Identity of the rule that produced these violations.

Returns

The corresponding bound validation outcome.

Errors

Returns ValidationOutcomeError::EmptyViolations when an invalid result has no drafts.

Trait Implementations

impl Debug for PreparedOutcome

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

Formats the value using the given formatter.

impl Eq for PreparedOutcome

impl PartialEq for PreparedOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PreparedOutcome