demes-forward 0.6.0

rust API for iterating demes models forwards in time
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

/// Error type.
#[derive(Debug)]
#[non_exhaustive]
pub enum DemesForwardError {
    /// Stores a [`demes::DemesError`].
    DemesError(demes::DemesError),
    /// Errors related to time.
    /// Will be returned if invalid time
    /// values occur after converting
    /// time to generations.
    TimeError(String),
    /// Errors related to invalid deme sizes
    /// arising during application of size change
    /// functions.
    InvalidDemeSize(f64),
    /// Errors related to invalid internal states.
    /// In general, this error indicates a bug
    /// that should be reported.
    InternalError(String),
}

impl From<demes::DemesError> for DemesForwardError {
    fn from(value: demes::DemesError) -> Self {
        Self::DemesError(value)
    }
}

impl std::fmt::Display for DemesForwardError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            DemesForwardError::DemesError(e) => write!(f, "{e:?}"),
            DemesForwardError::TimeError(msg) => write!(f, "time error: {msg}"),
            DemesForwardError::InvalidDemeSize(value) => write!(f, "invalid deme size: {value}"),
            DemesForwardError::InternalError(msg) => write!(f, "internal error: {msg}"),
        }
    }
}

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