tari_comms 5.3.0-pre.3

A peer-to-peer messaging system
Documentation 
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

// 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;

use thiserror::Error;

/// Error type for protocol module.
#[derive(Debug, Error)]
pub enum ProtocolError {
    #[error("IO error: {0}")]
    IoError(#[from] io::Error),
    #[error("Invalid flag: {0}")]
    InvalidFlag(String),
    #[error("The ProtocolId was longer than {}", u8::MAX)]
    ProtocolIdTooLong,
    #[error("Protocol negotiation failed because the peer did not accept any of the given protocols: {protocols}")]
    ProtocolOutboundNegotiationFailed { protocols: String },
    #[error("Protocol negotiation failed because the peer did not offer any protocols supported by this node")]
    ProtocolInboundNegotiationFailed,
    #[error("Optimistic protocol negotiation failed because the peer did not offer a protocol supported by this node")]
    ProtocolOptimisticNegotiationFailed,
    #[error("Protocol negotiation terminated by peer")]
    ProtocolNegotiationTerminatedByPeer,
    #[error("Protocol was not registered")]
    ProtocolNotRegistered,
    #[error("Failed to send notification because notification sender disconnected")]
    NotificationSenderDisconnected,
    #[error("Expected to ready bytes, that are not in the buffer")]
    ExpectedReadyBytes,
}

impl ProtocolError {
    pub fn is_ban_offence(&self) -> bool {
        match self {
            ProtocolError::IoError(_) |
            ProtocolError::ProtocolNegotiationTerminatedByPeer |
            ProtocolError::ProtocolOutboundNegotiationFailed { .. } |
            ProtocolError::ProtocolNotRegistered |
            ProtocolError::ProtocolInboundNegotiationFailed |
            ProtocolError::ProtocolOptimisticNegotiationFailed |
            ProtocolError::ExpectedReadyBytes |
            ProtocolError::NotificationSenderDisconnected => false,

            ProtocolError::ProtocolIdTooLong | ProtocolError::InvalidFlag(_) => true,
        }
    }
}