raz-validation 0.2.4

Smart options validation system for raz
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

//! Validation error types

use thiserror::Error;

pub type ValidationResult<T> = Result<T, ValidationError>;

#[derive(Error, Debug, Clone)]
pub enum ValidationError {
    #[error("Unknown option '{option}' for command '{command}'")]
    UnknownOption {
        command: String,
        option: String,
        suggestions: Vec<String>,
    },

    #[error("Invalid value '{value}' for option '{option}': {reason}")]
    InvalidValue {
        option: String,
        value: String,
        reason: String,
    },

    #[error("Option '{option}' conflicts with '{conflicts_with}'")]
    OptionConflict {
        option: String,
        conflicts_with: String,
    },

    #[error("Option '{option}' requires '{required}' to be specified")]
    MissingRequirement { option: String, required: String },

    #[error("Option '{option}' is deprecated: {message}")]
    DeprecatedOption { option: String, message: String },

    #[error("Option '{option}' expects a value")]
    MissingValue { option: String },

    #[error("Option '{option}' does not accept a value")]
    UnexpectedValue { option: String, value: String },

    #[error("Provider error: {message}")]
    ProviderError { message: String },
}

impl ValidationError {
    /// Create an unknown option error with suggestions
    pub fn unknown_option(
        command: impl Into<String>,
        option: impl Into<String>,
        suggestions: Vec<String>,
    ) -> Self {
        Self::UnknownOption {
            command: command.into(),
            option: option.into(),
            suggestions,
        }
    }

    /// Create an invalid value error
    pub fn invalid_value(
        option: impl Into<String>,
        value: impl Into<String>,
        reason: impl Into<String>,
    ) -> Self {
        Self::InvalidValue {
            option: option.into(),
            value: value.into(),
            reason: reason.into(),
        }
    }

    /// Create a conflict error
    pub fn conflict(option: impl Into<String>, conflicts_with: impl Into<String>) -> Self {
        Self::OptionConflict {
            option: option.into(),
            conflicts_with: conflicts_with.into(),
        }
    }

    /// Create a missing requirement error
    pub fn missing_requirement(option: impl Into<String>, required: impl Into<String>) -> Self {
        Self::MissingRequirement {
            option: option.into(),
            required: required.into(),
        }
    }

    /// Create a deprecated option error
    pub fn deprecated(option: impl Into<String>, message: impl Into<String>) -> Self {
        Self::DeprecatedOption {
            option: option.into(),
            message: message.into(),
        }
    }

    /// Get formatted error message with suggestions
    pub fn format_with_suggestions(&self) -> String {
        match self {
            Self::UnknownOption {
                command,
                option,
                suggestions,
            } => {
                let mut msg = format!("Unknown option '{option}' for command '{command}'");
                if !suggestions.is_empty() {
                    msg.push_str(&format!("\nDid you mean: {}", suggestions.join(", ")));
                }
                msg
            }
            _ => self.to_string(),
        }
    }
}