qubit-validator 0.1.1

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

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

//! Domain-neutral validator parameter values.

use std::fmt;

/// One statically typed validator parameter value.
///
/// # Type Parameters
///
/// - `'a`: Lifetime of any borrowed string or slice carried by the value.
///
/// # Examples
///
/// ```
/// use qubit_validator::ValidationArgument;
///
/// let argument = ValidationArgument::String("admin");
/// assert_eq!(argument, ValidationArgument::String("admin"));
/// ```
#[derive(Clone, Copy, Eq, PartialEq)]
#[non_exhaustive]
pub enum ValidationArgument<'a> {
    /// A Boolean value.
    Bool(
        /// The supplied Boolean value.
        bool,
    ),
    /// A signed integer value.
    Integer(
        /// The supplied signed integer value.
        i128,
    ),
    /// An unsigned integer value.
    Unsigned(
        /// The supplied unsigned integer value.
        u128,
    ),
    /// A string value.
    String(
        /// The supplied borrowed string.
        &'a str,
    ),
    /// A Boolean list.
    BoolList(
        /// The supplied borrowed Boolean slice.
        &'a [bool],
    ),
    /// A signed integer list.
    IntegerList(
        /// The supplied borrowed signed integer slice.
        &'a [i128],
    ),
    /// An unsigned integer list.
    UnsignedList(
        /// The supplied borrowed unsigned integer slice.
        &'a [u128],
    ),
    /// A string list.
    StringList(
        /// The supplied borrowed slice of borrowed strings.
        &'a [&'a str],
    ),
}

impl fmt::Debug for ValidationArgument<'_> {
    /// Redacts scalar contents and reports only collection lengths.
    ///
    /// # Parameters
    ///
    /// - `formatter`: Receives the redacted representation.
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Bool(_) => formatter.write_str("Bool(<redacted>)"),
            Self::Integer(_) => formatter.write_str("Integer(<redacted>)"),
            Self::Unsigned(_) => formatter.write_str("Unsigned(<redacted>)"),
            Self::String(_) => formatter.write_str("String(<redacted>)"),
            Self::BoolList(values) => formatter.debug_struct("BoolList").field("len", &values.len()).finish(),
            Self::IntegerList(values) => formatter
                .debug_struct("IntegerList")
                .field("len", &values.len())
                .finish(),
            Self::UnsignedList(values) => formatter
                .debug_struct("UnsignedList")
                .field("len", &values.len())
                .finish(),
            Self::StringList(values) => formatter
                .debug_struct("StringList")
                .field("len", &values.len())
                .finish(),
        }
    }
}