rust-h11 0.1.0

A pure-Rust, bring-your-own-I/O implementation of HTTP/1.1
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

use std::fmt;

/// Error caused by invalid local API usage or invalid locally-created events.
#[derive(Debug, PartialEq, Eq)]
pub struct LocalProtocolError {
    /// Human-readable error message.
    pub message: String,
    /// Suggested HTTP status code for this protocol error.
    pub code: u16,
}

impl From<(String, u16)> for LocalProtocolError {
    fn from(value: (String, u16)) -> Self {
        LocalProtocolError {
            message: value.0,
            code: value.1,
        }
    }
}

impl From<(&str, u16)> for LocalProtocolError {
    fn from(value: (&str, u16)) -> Self {
        LocalProtocolError {
            message: value.0.to_string(),
            code: value.1,
        }
    }
}

impl From<String> for LocalProtocolError {
    fn from(value: String) -> Self {
        LocalProtocolError {
            message: value,
            code: 400,
        }
    }
}

impl From<&str> for LocalProtocolError {
    fn from(value: &str) -> Self {
        LocalProtocolError {
            message: value.to_string(),
            code: 400,
        }
    }
}

impl LocalProtocolError {
    pub(crate) fn _reraise_as_remote_protocol_error(self) -> RemoteProtocolError {
        RemoteProtocolError {
            message: self.message,
            code: self.code,
        }
    }
}

impl fmt::Display for LocalProtocolError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} (status code {})", self.message, self.code)
    }
}

impl std::error::Error for LocalProtocolError {}

/// Error caused by malformed peer input.
#[derive(Debug, PartialEq, Eq)]
pub struct RemoteProtocolError {
    /// Human-readable error message.
    pub message: String,
    /// Suggested HTTP status code for this protocol error.
    pub code: u16,
}

impl From<(String, u16)> for RemoteProtocolError {
    fn from(value: (String, u16)) -> Self {
        RemoteProtocolError {
            message: value.0,
            code: value.1,
        }
    }
}

impl From<(&str, u16)> for RemoteProtocolError {
    fn from(value: (&str, u16)) -> Self {
        RemoteProtocolError {
            message: value.0.to_string(),
            code: value.1,
        }
    }
}

impl From<String> for RemoteProtocolError {
    fn from(value: String) -> Self {
        RemoteProtocolError {
            message: value,
            code: 400,
        }
    }
}

impl From<&str> for RemoteProtocolError {
    fn from(value: &str) -> Self {
        RemoteProtocolError {
            message: value.to_string(),
            code: 400,
        }
    }
}

impl fmt::Display for RemoteProtocolError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} (status code {})", self.message, self.code)
    }
}

impl std::error::Error for RemoteProtocolError {}

/// Protocol error wrapper used by fallible public APIs.
#[derive(Debug, PartialEq, Eq)]
pub enum ProtocolError {
    /// Local protocol misuse.
    LocalProtocolError(LocalProtocolError),
    /// Remote peer protocol violation.
    RemoteProtocolError(RemoteProtocolError),
}

impl From<LocalProtocolError> for ProtocolError {
    fn from(value: LocalProtocolError) -> Self {
        ProtocolError::LocalProtocolError(value)
    }
}

impl From<RemoteProtocolError> for ProtocolError {
    fn from(value: RemoteProtocolError) -> Self {
        ProtocolError::RemoteProtocolError(value)
    }
}

impl fmt::Display for ProtocolError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::LocalProtocolError(error) => write!(f, "local protocol error: {}", error),
            Self::RemoteProtocolError(error) => write!(f, "remote protocol error: {}", error),
        }
    }
}

impl std::error::Error for ProtocolError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::LocalProtocolError(error) => Some(error),
            Self::RemoteProtocolError(error) => Some(error),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::error::Error;

    #[test]
    fn protocol_errors_implement_display_and_error() {
        let local = LocalProtocolError::from(("bad request", 400));
        assert_eq!(local.to_string(), "bad request (status code 400)");

        let remote = RemoteProtocolError::from(("bad gateway", 502));
        assert_eq!(remote.to_string(), "bad gateway (status code 502)");

        let error = ProtocolError::from(LocalProtocolError::from(("invalid", 400)));
        assert_eq!(
            error.to_string(),
            "local protocol error: invalid (status code 400)"
        );
        assert!(error.source().is_some());
    }
}