khanij 1.1.0

Khanij — geology and mineralogy engine for crystal structures, rock cycles, soil, and mineral properties
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

use thiserror::Error;

/// # Examples
///
/// ```
/// # use khanij::*;
/// let err = KhanijError::InvalidMineral("unobtanium".into());
/// assert!(err.to_string().contains("unobtanium"));
///
/// let err = KhanijError::InvalidComposition("negative weight%".into());
/// assert!(err.to_string().contains("negative weight%"));
/// ```
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum KhanijError {
    #[error("invalid mineral: {0}")]
    InvalidMineral(String),
    #[error("invalid composition: {0}")]
    InvalidComposition(String),
    #[error("invalid hardness: {0}")]
    InvalidHardness(String),
    #[error("computation error: {0}")]
    ComputationError(String),
}

pub type Result<T> = std::result::Result<T, KhanijError>;

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn error_display() {
        let e = KhanijError::InvalidMineral("unobtanium".into());
        assert!(e.to_string().contains("unobtanium"));
    }
}