qubit-validator 0.1.0

Type-safe validation traits and registries for Qubit applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================

//! Explicitly skipped validation occurrences.

use super::FailureId;
use super::SkipReason;
use super::ValidationOutcomeError;
use super::ValidationPath;

/// One validation occurrence that was skipped by the executor.
///
/// # Examples
///
/// ```
/// use qubit_validator::{SkipReason, SkippedValidation, ValidationPath};
///
/// let skipped = SkippedValidation::missing_optional(
///     0,
///     ValidationPath::root().with_field("optional"),
/// );
/// assert_eq!(skipped.reason(), SkipReason::MissingOptional);
/// ```
#[must_use]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct SkippedValidation {
    /// Zero-based declaration occurrence assigned by the executor.
    occurrence: usize,
    /// Structured path of the skipped target.
    path: ValidationPath,
    /// Policy reason the occurrence did not execute.
    reason: SkipReason,
    /// IDs of failures that prevented this occurrence; empty for an absent
    /// optional target.
    prerequisites: Vec<FailureId>,
}

impl SkippedValidation {
    /// Creates a record for an absent optional target.
    ///
    /// # Parameters
    ///
    /// - `occurrence`: Zero-based declaration position of the skipped target.
    /// - `path`: Structured path identifying the absent target.
    ///
    /// # Returns
    ///
    /// A skipped occurrence with no prerequisite failures.
    #[inline]
    pub fn missing_optional(occurrence: usize, path: ValidationPath) -> Self {
        Self {
            occurrence,
            path,
            reason: SkipReason::MissingOptional,
            prerequisites: Vec::new(),
        }
    }

    /// Creates a record for an occurrence skipped after prerequisite
    /// failures.
    ///
    /// # Parameters
    ///
    /// - `occurrence`: Zero-based declaration position of the skipped target.
    /// - `path`: Structured path identifying the skipped target.
    /// - `prerequisites`: Failure IDs that prevented this occurrence from
    ///   running.
    ///
    /// # Errors
    ///
    /// Returns `EmptyPrerequisites` when no failure ID is supplied.
    ///
    /// # Returns
    ///
    /// A skipped occurrence containing the supplied prerequisite failure IDs.
    pub fn failed_prerequisite(
        occurrence: usize,
        path: ValidationPath,
        prerequisites: Vec<FailureId>,
    ) -> Result<Self, ValidationOutcomeError> {
        if prerequisites.is_empty() {
            return Err(ValidationOutcomeError::EmptyPrerequisites);
        }
        Ok(Self {
            occurrence,
            path,
            reason: SkipReason::FailedPrerequisite,
            prerequisites,
        })
    }

    /// Returns the zero-based declaration occurrence assigned by the executor.
    ///
    /// # Returns
    ///
    /// The occurrence number used to order this validation result.
    #[must_use]
    #[inline]
    pub const fn occurrence(&self) -> usize {
        self.occurrence
    }

    /// Returns the structured path of the skipped target.
    ///
    /// # Returns
    ///
    /// A borrow of the target path stored in this record.
    #[must_use]
    #[inline]
    pub const fn path(&self) -> &ValidationPath {
        &self.path
    }

    /// Returns why the executor did not run this occurrence.
    ///
    /// # Returns
    ///
    /// The policy reason that caused the skip.
    #[must_use]
    #[inline]
    pub const fn reason(&self) -> SkipReason {
        self.reason
    }

    /// Returns IDs of failures that prevented this occurrence.
    ///
    /// # Returns
    ///
    /// The prerequisite IDs, or an empty slice when an optional target was
    /// absent.
    #[must_use = "inspect the prerequisite failure IDs"]
    #[inline]
    pub fn prerequisites(&self) -> &[FailureId] {
        &self.prerequisites
    }
}