tari_comms 5.3.0

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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//  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 std::io;

use tari_common_sqlite::error::StorageError;
use tari_comms::{
    CommsBuilderError,
    PeerConnectionError,
    connectivity::ConnectivityError,
    message::OutboundMessage,
    peer_manager::PeerManagerError,
    tor,
};
use tari_utilities::message_format::MessageFormatError;
use thiserror::Error;
use tokio::{
    sync::{mpsc::error::SendError, oneshot},
    task,
    time,
};

#[derive(Debug, Error)]
#[allow(clippy::enum_variant_names)]
pub enum Error {
    #[error("HiddenServiceBuilderError: {0}")]
    HiddenServiceBuilderError(#[from] tor::HiddenServiceBuilderError),
    #[error("HiddenServiceControllerError: {0}")]
    HiddenServiceControllerError(#[from] tor::HiddenServiceControllerError),
    #[error("CommsBuilderError: {0}")]
    CommsBuilderError(#[from] CommsBuilderError),
    #[error("PeerManagerError: {0}")]
    PeerManagerError(#[from] PeerManagerError),
    #[error("Connection error: {0}")]
    PeerConnectionError(#[from] PeerConnectionError),
    #[error("Connectivity error: {0}")]
    ConnectivityError(#[from] ConnectivityError),
    #[error("Message format error: {0}")]
    MessageFormatError(String),
    #[error("Failed to send message: {0}")]
    SendError(#[from] SendError<OutboundMessage>),
    #[error("JoinError: {0}")]
    JoinError(#[from] task::JoinError),
    #[error("Example did not exit cleanly: `{0}`")]
    WaitTimeout(#[from] time::error::Elapsed),
    #[error("IO error: {0}")]
    Io(#[from] io::Error),
    #[error("User quit")]
    UserQuit,
    #[error("Peer sent an invalid protocol frame")]
    InvalidProtocolFrame,
    #[error("Unexpected EoF")]
    UnexpectedEof,
    #[error("Internal reply canceled")]
    ReplyCanceled(#[from] oneshot::error::RecvError),
    #[error("StorageError: {0}")]
    StorageError(#[from] StorageError),
}

impl From<MessageFormatError> for Error {
    fn from(value: MessageFormatError) -> Self {
        Error::MessageFormatError(value.to_string())
    }
}