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
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101

// Copyright 2020 Contributors to the Parsec project.
// SPDX-License-Identifier: Apache-2.0
//! Error types specific to the Parsec client
use parsec_interface::requests::ResponseStatus;
use std::error;
use std::fmt;

/// Enum used to denote errors returned to the library user
#[derive(Debug, PartialEq)]
pub enum Error {
    /// Errors originating in the service
    Service(ResponseStatus),
    /// Errors originating in the client
    Client(ClientErrorKind),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Error::Service(response_status) => response_status.fmt(f),
            Error::Client(client_error_kind) => client_error_kind.fmt(f),
        }
    }
}
impl error::Error for Error {}

/// Types of errors local to the client library
#[derive(Debug)]
pub enum ClientErrorKind {
    /// Errors generated by the Parsec interface library
    Interface(ResponseStatus),
    /// Errors generated by interacting with the underlying IPC mechanism
    Ipc(::std::io::Error),
    /// The opcode of the response does not match the opcode of the request
    InvalidServiceResponseType,
    /// The operation is not supported by the selected provider
    InvalidProvider,
    /// Client is missing an implicit provider
    NoProvider,
    /// Service is missing authenticator or none of the authenticators is supported
    /// by the client
    NoAuthenticator,
    /// Required parameter was not provided
    MissingParam,
}

impl From<ClientErrorKind> for Error {
    fn from(client_error: ClientErrorKind) -> Self {
        Error::Client(client_error)
    }
}

impl PartialEq for ClientErrorKind {
    fn eq(&self, other: &Self) -> bool {
        match self {
            ClientErrorKind::Interface(status) => {
                if let ClientErrorKind::Interface(other_status) = other {
                    other_status == status
                } else {
                    false
                }
            }
            ClientErrorKind::Ipc(error) => {
                if let ClientErrorKind::Ipc(other_error) = other {
                    other_error.kind() == error.kind()
                } else {
                    false
                }
            }
            ClientErrorKind::InvalidServiceResponseType => {
                matches!(other, ClientErrorKind::InvalidServiceResponseType)
            }
            ClientErrorKind::InvalidProvider => matches!(other, ClientErrorKind::InvalidProvider),
            ClientErrorKind::NoProvider => matches!(other, ClientErrorKind::NoProvider),
            ClientErrorKind::NoAuthenticator => matches!(other, ClientErrorKind::NoAuthenticator),
            ClientErrorKind::MissingParam => matches!(other, ClientErrorKind::MissingParam),
        }
    }
}

impl fmt::Display for ClientErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            ClientErrorKind::Interface(response_status) => response_status.fmt(f),
            ClientErrorKind::Ipc(error) => error.fmt(f),
            ClientErrorKind::InvalidServiceResponseType => write!(
                f,
                "the opcode of the response does not match the opcode of the request"
            ),
            ClientErrorKind::InvalidProvider => {
                write!(f, "operation not supported by selected provider")
            }
            ClientErrorKind::NoProvider => write!(f, "client is missing an implicit provider"),
            ClientErrorKind::NoAuthenticator => write!(f, "service is not reporting any authenticators or none of the reported ones are supported by the client"),
            ClientErrorKind::MissingParam => write!(f, "one of the `Option` parameters was required but was not provided"),
        }
    }
}

/// Result type used for the internals and interface of the Parsec client
pub type Result<T> = ::std::result::Result<T, Error>;