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
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//
// Copyright (C) 2018 Kubos Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

use cbor_protocol;
use failure::Fail;
use serde_cbor;
use std::io;

/// Errors which occur when using FileProtocol
#[derive(Debug, Fail)]
pub enum ProtocolError {
    /// A file in storage was corrupt
    #[fail(display = "File was corrupt: {}", _0)]
    CorruptFile(String),
    /// An error was encountered by the cbor protocol
    #[fail(display = "Cbor Error: {}", err)]
    CborError {
        /// The specific cbor protocol error
        err: cbor_protocol::ProtocolError,
    },
    /// An error was encountered when finalizing the file
    #[fail(display = "Failed to finalize file: {}", cause)]
    FinalizeError {
        /// The cause of the finalizing failure
        cause: String,
    },
    /// A hash mismatch was found when finalizing the file
    #[fail(display = "File hash mismatch")]
    HashMismatch,
    /// An invalid value was found when parsing a message
    #[fail(display = "Unable to parse {} message: Invalid {} param", _0, _1)]
    InvalidParam(String, String),
    /// An error was encountered when creating a message
    #[fail(display = "Failed to create {} message: {}", message, err)]
    MessageCreationError {
        /// The message which failed creation
        message: String,
        /// The underlying serde error encountered
        err: serde_cbor::error::Error,
    },
    /// A general error was encountered when parsing a message
    #[fail(display = "Unable to parse message: {}", err)]
    MessageParseError {
        /// Underlying error encountered
        err: String,
    },
    /// A value was missing when parsing a message
    #[fail(display = "Unable to parse {} message: No {} param", _0, _1)]
    MissingParam(String, String),
    /// An error was encountered when receiving a message
    #[fail(display = "Failure receiving message: {}", err)]
    ReceiveError {
        /// Underlying error encountered
        err: String,
    },
    /// An error was encountered when serializing data
    #[fail(display = "Failed to serialize: {}", err)]
    Serialize {
        /// Underlying serde error
        err: serde_cbor::error::Error,
    },
    /// An error was encountered when writing to or reading from file storage
    #[fail(display = "Storage failed to {}: {}", action, err)]
    StorageError {
        /// The action which generated the error
        action: String,
        /// The underlying std::io::Error
        err: io::Error,
    },
    /// An error was encountered when parsing file storage data
    #[fail(display = "{}", _0)]
    StorageParseError(String),
    /// A timeout occurred when receiving data
    #[fail(display = "A receive timeout was encountered")]
    ReceiveTimeout,
    /// An error was encountered when transmitting
    #[fail(
        display = "Transmission failure on channel {}: {}",
        channel_id, error_message
    )]
    TransmissionError {
        /// Channel where the error occurred
        channel_id: u32,
        /// Message from underlying error
        error_message: String,
    },
}

impl From<cbor_protocol::ProtocolError> for ProtocolError {
    fn from(error: cbor_protocol::ProtocolError) -> Self {
        match error {
            cbor_protocol::ProtocolError::Timeout => ProtocolError::ReceiveTimeout,
            err => ProtocolError::CborError { err },
        }
    }
}

impl From<serde_cbor::error::Error> for ProtocolError {
    fn from(error: serde_cbor::error::Error) -> Self {
        ProtocolError::Serialize { err: error }
    }
}