tari_comms 5.3.0-pre.10

A peer-to-peer messaging system
Documentation
// Copyright 2020, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::io::{self, ErrorKind};

use thiserror::Error;
use tokio::sync::mpsc;

use crate::{
    connection_manager::PeerConnectionError,
    connectivity::ConnectivityError,
    message::OutboundMessage,
    protocol::ProtocolError,
};

/// Error type for the messaging protocol.
#[derive(Debug, Error)]
pub enum MessagingProtocolError {
    #[error("Failed to send message")]
    MessageSendFailed,
    #[error("ProtocolError: {0}")]
    ProtocolError(#[from] ProtocolError),
    #[error("PeerConnectionError: {0}")]
    PeerConnectionError(#[from] PeerConnectionError),
    #[error("Failed to dial peer: {0}")]
    PeerDialFailed(ConnectivityError),
    #[error("Connectivity error: {0}")]
    ConnectivityError(#[from] ConnectivityError),
    #[error("IO Error: {0}")]
    Io(io::Error),
    #[error("Sender error: {0}")]
    SenderError(#[from] mpsc::error::SendError<OutboundMessage>),
    #[error("Connection closed")]
    ConnectionClosed(io::Error),
}

impl From<io::Error> for MessagingProtocolError {
    fn from(err: io::Error) -> Self {
        match err.kind() {
            ErrorKind::ConnectionRefused |
            ErrorKind::ConnectionReset |
            ErrorKind::ConnectionAborted |
            ErrorKind::BrokenPipe |
            ErrorKind::WriteZero |
            ErrorKind::NotConnected |
            ErrorKind::UnexpectedEof => MessagingProtocolError::ConnectionClosed(err),
            _ => MessagingProtocolError::Io(err),
        }
    }
}