wsproxy 0.1.3

WebSocket proxy for TCP connections
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
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
116

//! Error types for the wsproxy library.

use std::backtrace::{Backtrace, BacktraceStatus};
use std::{fmt, io};

/// Result type alias using the library's Error type.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that can occur in the wsproxy library.
pub struct Error {
    kind: ErrorKind,
    backtrace: Backtrace,
}

#[derive(Debug)]
enum ErrorKind {
    /// I/O error.
    Io(io::Error),
    /// WebSocket error.
    WebSocket(tokio_tungstenite::tungstenite::Error),
    /// No route found for the requested path.
    NoRouteFound(String),
    /// Configuration error.
    Config(String),
}

impl Error {
    /// Create a new NoRouteFound error.
    pub fn no_route_found(path: impl Into<String>) -> Self {
        Self {
            kind: ErrorKind::NoRouteFound(path.into()),
            backtrace: Backtrace::capture(),
        }
    }

    /// Create a new Config error.
    pub fn config(message: impl Into<String>) -> Self {
        Self {
            kind: ErrorKind::Config(message.into()),
            backtrace: Backtrace::capture(),
        }
    }

    /// Returns the backtrace associated with this error.
    pub fn backtrace(&self) -> &Backtrace {
        &self.backtrace
    }
}

impl fmt::Debug for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // anyhow-style formatting
        writeln!(f, "{self}")?;

        // Print error chain
        let mut source = std::error::Error::source(self);
        if source.is_some() {
            writeln!(f)?;
            writeln!(f, "Caused by:")?;
            let mut i = 0;
            while let Some(err) = source {
                writeln!(f, "    {i}: {err}")?;
                source = err.source();
                i += 1;
            }
        }

        // Print backtrace if captured
        if self.backtrace.status() == BacktraceStatus::Captured {
            writeln!(f)?;
            writeln!(f, "Stack backtrace:")?;
            write!(f, "{}", self.backtrace)?;
        }

        Ok(())
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match &self.kind {
            ErrorKind::Io(e) => write!(f, "I/O error: {e}"),
            ErrorKind::WebSocket(e) => write!(f, "WebSocket error: {e}"),
            ErrorKind::NoRouteFound(path) => write!(f, "No route found for path: {path}"),
            ErrorKind::Config(msg) => write!(f, "Configuration error: {msg}"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match &self.kind {
            ErrorKind::Io(e) => Some(e),
            ErrorKind::WebSocket(e) => Some(e),
            ErrorKind::NoRouteFound(_) | ErrorKind::Config(_) => None,
        }
    }
}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Self {
        Self {
            kind: ErrorKind::Io(err),
            backtrace: Backtrace::capture(),
        }
    }
}

impl From<tokio_tungstenite::tungstenite::Error> for Error {
    fn from(err: tokio_tungstenite::tungstenite::Error) -> Self {
        Self {
            kind: ErrorKind::WebSocket(err),
            backtrace: Backtrace::capture(),
        }
    }
}