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

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

//! Dependency slot declarations for prepared validators.

use super::InputType;

/// Describes one ordered dependency slot supplied to a validator.
///
/// # Examples
///
/// ```
/// use qubit_validator::{DependencySpec, InputType};
///
/// let dependency = DependencySpec::new("credential", InputType::Text, false);
/// assert_eq!(dependency.name(), "credential");
/// assert!(!dependency.optional());
/// ```
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct DependencySpec {
    /// Logical slot name used in diagnostics.
    name: &'static str,
    /// Erased value shape required by the slot.
    input: InputType,
    /// Whether the explicit missing marker is accepted.
    optional: bool,
}

impl DependencySpec {
    /// Creates a dependency declaration.
    ///
    /// # Parameters
    ///
    /// - `name`: non-empty logical slot name used in diagnostics.
    /// - `input`: erased value shape required by the slot.
    /// - `optional`: whether an explicit missing value is accepted.
    ///
    /// # Returns
    ///
    /// Returns a declaration containing the supplied dependency metadata.
    ///
    /// # Panics
    ///
    /// Panics when `name` is empty.
    #[must_use]
    #[inline]
    pub const fn new(name: &'static str, input: InputType, optional: bool) -> Self {
        assert!(!name.is_empty(), "dependency name cannot be empty");
        Self { name, input, optional }
    }

    /// Returns the logical slot name.
    #[must_use]
    #[inline]
    pub const fn name(self) -> &'static str {
        self.name
    }

    /// Returns the required input shape.
    #[must_use]
    #[inline]
    pub const fn input(self) -> InputType {
        self.input
    }

    /// Returns whether an explicit missing value is accepted.
    ///
    /// # Returns
    ///
    /// Returns `true` when the dependency accepts
    /// [`super::ValidationValue::Missing`].
    #[must_use]
    #[inline]
    pub const fn optional(self) -> bool {
        self.optional
    }
}