argmin_core 0.2.4

// Copyright 2018 Stefan Kroboth
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! # Errors
//!
//! Gigantic TODO: Remove `failure` dependency and implement own error handling.

use failure_derive::Fail;

#[derive(Debug, Fail)]
pub enum ArgminError {
    /// Indicates and invalid parameter
    #[fail(display = "Invalid parameter: {}", text)]
    InvalidParameter { text: String },

    /// Indicates that a function is not implemented
    #[fail(display = "Not implemented: {}", text)]
    NotImplemented { text: String },

    /// Indicates that a function is not initialized
    #[fail(display = "Not initialized: {}", text)]
    NotInitialized { text: String },

    /// Indicates that a condition is violated
    #[fail(display = "Condition violated: {}", text)]
    ConditionViolated { text: String },

    /// Checkpoint was not found
    #[fail(display = "Checkpoint not found: {}", text)]
    CheckpointNotFound { text: String },

    /// Indicates an impossible error
    #[fail(display = "Impossible Error: {}", text)]
    ImpossibleError { text: String },
}

#[cfg(test)]
mod tests {
    use super::*;

    send_sync_test!(error, ArgminError);
}