qubit-argument 0.4.7

Structured, ownership-preserving argument validation for Rust 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

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

use crate::argument::ArgumentValue;

/// A comparison between an argument and a captured scalar value.
///
/// # Examples
///
/// ```
/// use qubit_argument::{ArgumentValue, ComparisonConstraint};
///
/// let constraint = ComparisonConstraint::AtLeast(ArgumentValue::from(10_i32));
/// assert!(matches!(constraint, ComparisonConstraint::AtLeast(_)));
/// ```
///
/// ```compile_fail
/// #![deny(unused_must_use)]
/// use qubit_argument::{ArgumentValue, ComparisonConstraint};
///
/// ComparisonConstraint::EqualTo(ArgumentValue::Signed(1));
/// ```
#[must_use]
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ComparisonConstraint {
    /// Requires equality with the captured value.
    EqualTo(ArgumentValue),
    /// Requires inequality with the captured value.
    NotEqualTo(ArgumentValue),
    /// Requires a value strictly less than the captured value.
    LessThan(ArgumentValue),
    /// Requires a value less than or equal to the captured value.
    AtMost(ArgumentValue),
    /// Requires a value strictly greater than the captured value.
    GreaterThan(ArgumentValue),
    /// Requires a value greater than or equal to the captured value.
    AtLeast(ArgumentValue),
}