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

//! Error types.

use thiserror::Error;

use crate::ffi;

/// Wraps all error types returned by `minion_rs`.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum MinionError {
    /// An error has occurred during the execution of Minion.
    #[error("runtime error: `{0}.to_string()`")]
    RuntimeError(#[from] RuntimeError),

    /// The input model uses Minion features that are not yet implemented in `minion_rs`.
    #[error("not implemented: {0}")]
    NotImplemented(String),

    /// Catch-all error.
    #[error(transparent)]
    Other(#[from] anyhow::Error), // source and Display delegate to anyhow::Error
}

/// Errors thrown by Minion during execution.
///
/// These represent internal Minion C++ exceptions translated into Rust.
///
/// Invalid usage of this library should throw an error before Minion is even run. Therefore, these
/// should be quite rare. Consider creating an issue on
/// [Github](https://github.com/conjure-cp/conjure-oxide) if these occur regularly!
#[derive(Debug, Error, Eq, PartialEq)]
#[non_exhaustive]
pub enum RuntimeError {
    // These closely follow the ReturnCodes found in Minion's libwrapper.cpp.
    /// The model given to Minion is invalid.
    #[error("the given instance is invalid")]
    InvalidInstance,

    /// An unknown error has occurred.
    #[error("an unknown error has occurred while running minion")]
    UnknownError,
}

// Minion's ReturnCodes are passed over FFI as ints.
// Convert them to their appropriate error.
impl From<u32> for RuntimeError {
    fn from(return_code: u32) -> Self {
        match return_code {
            #[allow(non_upper_case_globals)]
            ffi::ReturnCodes_INVALID_INSTANCE => RuntimeError::InvalidInstance,
            _ => RuntimeError::UnknownError,
        }
    }
}