interledger-packet 0.4.0

use std::fmt;
use std::str;

#[derive(Clone, Copy, Eq, PartialEq)]
pub struct ErrorCode([u8; 3]);

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ErrorClass {
    Final,
    Temporary,
    Relative,
    Unknown,
}

impl ErrorCode {
    #[inline]
    pub const fn new(bytes: [u8; 3]) -> Self {
        ErrorCode(bytes)
    }

    #[inline]
    pub fn class(self) -> ErrorClass {
        match self.0[0] {
            b'F' => ErrorClass::Final,
            b'T' => ErrorClass::Temporary,
            b'R' => ErrorClass::Relative,
            _ => ErrorClass::Unknown,
        }
    }

    // Error codes from: <https://github.com/interledger/rfcs/blob/master/0027-interledger-protocol-4/0027-interledger-protocol-4.md#error-codes>

    // Final errors:
    pub const F00_BAD_REQUEST: Self = ErrorCode(*b"F00");
    pub const F01_INVALID_PACKET: Self = ErrorCode(*b"F01");
    pub const F02_UNREACHABLE: Self = ErrorCode(*b"F02");
    pub const F03_INVALID_AMOUNT: Self = ErrorCode(*b"F03");
    pub const F04_INSUFFICIENT_DESTINATION_AMOUNT: Self = ErrorCode(*b"F04");
    pub const F05_WRONG_CONDITION: Self = ErrorCode(*b"F05");
    pub const F06_UNEXPECTED_PAYMENT: Self = ErrorCode(*b"F06");
    pub const F07_CANNOT_RECEIVE: Self = ErrorCode(*b"F07");
    pub const F08_AMOUNT_TOO_LARGE: Self = ErrorCode(*b"F08");
    pub const F09_INVALID_PEER_RESPONSE: Self = ErrorCode(*b"F09");
    pub const F99_APPLICATION_ERROR: Self = ErrorCode(*b"F99");

    // Temporary errors:
    pub const T00_INTERNAL_ERROR: Self = ErrorCode(*b"T00");
    pub const T01_PEER_UNREACHABLE: Self = ErrorCode(*b"T01");
    pub const T02_PEER_BUSY: Self = ErrorCode(*b"T02");
    pub const T03_CONNECTOR_BUSY: Self = ErrorCode(*b"T03");
    pub const T04_INSUFFICIENT_LIQUIDITY: Self = ErrorCode(*b"T04");
    pub const T05_RATE_LIMITED: Self = ErrorCode(*b"T05");
    pub const T99_APPLICATION_ERROR: Self = ErrorCode(*b"T99");

    // Relative errors:
    pub const R00_TRANSFER_TIMED_OUT: Self = ErrorCode(*b"R00");
    pub const R01_INSUFFICIENT_SOURCE_AMOUNT: Self = ErrorCode(*b"R01");
    pub const R02_INSUFFICIENT_TIMEOUT: Self = ErrorCode(*b"R02");
    pub const R99_APPLICATION_ERROR: Self = ErrorCode(*b"R99");
}

impl From<ErrorCode> for [u8; 3] {
    fn from(error_code: ErrorCode) -> Self {
        error_code.0
    }
}

impl fmt::Debug for ErrorCode {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter
            .debug_tuple("ErrorCode")
            .field(&str::from_utf8(&self.0[..]).map_err(|_| fmt::Error)?)
            .finish()
    }
}

impl fmt::Display for ErrorCode {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        let as_str = str::from_utf8(&self.0[..]).map_err(|_| fmt::Error)?;
        formatter.write_str(as_str)
    }
}

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

    #[test]
    fn test_class() {
        assert_eq!(ErrorCode::F00_BAD_REQUEST.class(), ErrorClass::Final);
        assert_eq!(ErrorCode::T00_INTERNAL_ERROR.class(), ErrorClass::Temporary);
        assert_eq!(
            ErrorCode::R00_TRANSFER_TIMED_OUT.class(),
            ErrorClass::Relative
        );
        assert_eq!(ErrorCode::new(*b"???").class(), ErrorClass::Unknown);
    }

    #[test]
    fn test_debug_printing() {
        assert_eq!(
            format!("{:?}", ErrorCode::F00_BAD_REQUEST),
            String::from("ErrorCode(\"F00\")")
        );
    }

    #[test]
    fn test_final_error_values() {
        assert_eq!(
            format!("{}", ErrorCode::F00_BAD_REQUEST),
            String::from("F00")
        );
        assert_eq!(
            format!("{}", ErrorCode::F01_INVALID_PACKET),
            String::from("F01")
        );
        assert_eq!(
            format!("{}", ErrorCode::F02_UNREACHABLE),
            String::from("F02")
        );
        assert_eq!(
            format!("{}", ErrorCode::F03_INVALID_AMOUNT),
            String::from("F03")
        );
        assert_eq!(
            format!("{}", ErrorCode::F04_INSUFFICIENT_DESTINATION_AMOUNT),
            String::from("F04")
        );
        assert_eq!(
            format!("{}", ErrorCode::F05_WRONG_CONDITION),
            String::from("F05")
        );
        assert_eq!(
            format!("{}", ErrorCode::F06_UNEXPECTED_PAYMENT),
            String::from("F06")
        );
        assert_eq!(
            format!("{}", ErrorCode::F07_CANNOT_RECEIVE),
            String::from("F07")
        );
        assert_eq!(
            format!("{}", ErrorCode::F08_AMOUNT_TOO_LARGE),
            String::from("F08")
        );
        assert_eq!(
            format!("{}", ErrorCode::F09_INVALID_PEER_RESPONSE),
            String::from("F09")
        );
        assert_eq!(
            format!("{}", ErrorCode::F99_APPLICATION_ERROR),
            String::from("F99")
        );
    }

    #[test]
    fn test_temporary_error_values() {
        assert_eq!(
            format!("{}", ErrorCode::T00_INTERNAL_ERROR),
            String::from("T00")
        );
        assert_eq!(
            format!("{}", ErrorCode::T01_PEER_UNREACHABLE),
            String::from("T01")
        );
        assert_eq!(format!("{}", ErrorCode::T02_PEER_BUSY), String::from("T02"));
        assert_eq!(
            format!("{}", ErrorCode::T03_CONNECTOR_BUSY),
            String::from("T03")
        );
        assert_eq!(
            format!("{}", ErrorCode::T04_INSUFFICIENT_LIQUIDITY),
            String::from("T04")
        );
        assert_eq!(
            format!("{}", ErrorCode::T05_RATE_LIMITED),
            String::from("T05")
        );
        assert_eq!(
            format!("{}", ErrorCode::T99_APPLICATION_ERROR),
            String::from("T99")
        );
    }

    #[test]
    fn test_relative_error_values() {
        assert_eq!(
            format!("{}", ErrorCode::R00_TRANSFER_TIMED_OUT),
            String::from("R00")
        );
        assert_eq!(
            format!("{}", ErrorCode::R01_INSUFFICIENT_SOURCE_AMOUNT),
            String::from("R01")
        );
        assert_eq!(
            format!("{}", ErrorCode::R02_INSUFFICIENT_TIMEOUT),
            String::from("R02")
        );
        assert_eq!(
            format!("{}", ErrorCode::R99_APPLICATION_ERROR),
            String::from("R99")
        );
    }
}