forrustts 0.2.0

Tools for forward simulation with tree sequence recording
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

///! Error handling
use crate::nested_forward_list::NestedForwardListError;
use thiserror::Error;

/// Primary error type.
///
/// Some members of this enum implement ``From``
/// in order to redirect other error types.
#[derive(Error, Debug, PartialEq)]
pub enum ForrusttsError {
    /// An error that occurs during simplification.
    #[error("{value:?}")]
    SimplificationError {
        /// The error message
        value: String,
    },

    /// A redirection of a [``crate::nested_forward_list::NestedForwardListError``].
    #[error("{value:?}")]
    ListError {
        /// The redirected error
        #[from]
        value: NestedForwardListError,
    },
    /// A redirection of a [``crate::TablesError``]
    #[error("{value:?}")]
    TablesError {
        /// The redirected error
        #[from]
        value: crate::TablesError,
    },
}

#[cfg(test)]
mod test {

    use super::*;

    fn return_nested_forward_list_error(f: bool) -> Result<(), NestedForwardListError> {
        if f {
            Ok(())
        } else {
            Err(NestedForwardListError::InvalidIndex)
        }
    }

    fn return_simplification_error() -> Result<(), ForrusttsError> {
        match return_nested_forward_list_error(false) {
            Ok(_) => Ok(()),
            Err(e) => match e {
                NestedForwardListError::InvalidIndex => Err(ForrusttsError::ListError { value: e }),
                NestedForwardListError::NullTail => Err(ForrusttsError::ListError { value: e }),
                #[allow(unreachable_patterns)]
                _ => panic!(),
            },
        }
    }

    #[test]
    fn test_nested_forward_list_error_propagation() {
        match return_simplification_error() {
            Ok(_) => panic!(),
            Err(e) => match e {
                ForrusttsError::ListError { value } => match value {
                    NestedForwardListError::InvalidIndex => {
                        assert_eq!(value.to_string(), "Invalid index")
                    }
                    NestedForwardListError::NullTail => panic!(),
                },
                #[allow(unreachable_patterns)]
                _ => panic!(),
            },
        };
    }
}