Skip to main content

qubit_argument/argument/constraint/
pattern_expectation.rs

1// =============================================================================
2//    Copyright (c) 2025 - 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! Pattern expectations used by string validation.
9
10/// Whether a string is expected to match a pattern.
11///
12/// ```compile_fail
13/// #![deny(unused_must_use)]
14/// use qubit_argument::PatternExpectation;
15///
16/// PatternExpectation::Match;
17/// ```
18#[must_use]
19#[derive(Debug, Clone, Copy, PartialEq, Eq)]
20pub enum PatternExpectation {
21    /// Requires the string to match the pattern.
22    Match,
23    /// Requires the string not to match the pattern.
24    NoMatch,
25}