invariance 0.1.0

A Rust crate providing type-safe, validated configuration to prevent runtime crashes from invalid config data.
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

use std::fmt;

/// Error type for configuration parsing and validation issues.
#[derive(Debug)]
pub struct ConfigError {
    /// Human-readable description of the error.
    message: String,
}

impl ConfigError {
    /// Create a new `ConfigError` with the given message.
    ///
    /// # Arguments
    ///
    /// * `msg` - A message describing the error.
    ///
    /// # Examples
    ///
    /// ```
    /// use invariance::ConfigError;
    ///
    /// let err = ConfigError::new("invalid config value");
    /// ```
    pub fn new(msg: impl Into<String>) -> Self {
        ConfigError {
            message: msg.into(),
        }
    }
}

impl fmt::Display for ConfigError {
    /// Formats the error for display.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Configuration error: {}", self.message)
    }
}

impl std::error::Error for ConfigError {}