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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
use crate::*;
impl Default for Response {
fn default() -> Self {
Self::new()
}
}
impl Response {
/// Creates a new instance of `Response`.
///
/// # Returns
/// - An initialized `Response` with default values.
pub fn new() -> Self {
Response {
version: HTTP_VERSION_1_1.to_owned(),
status_code: 200,
reason_phrase: EMPTY_STR.to_owned(),
headers: hash_map_xxhash3_64(),
body: Vec::new(),
}
}
/// Retrieves the value of a response header by its key.
///
/// # Parameters
/// - `key`: The header's key, which can be of any type that implements `Into<ResponseHeadersKey>`.
///
/// # Returns
/// - `OptionResponseHeadersValue`: Returns `Some(value)` if the key exists in the response headers,
/// or `None` if the key does not exist.
pub fn get_header<K>(&self, key: K) -> OptionResponseHeadersValue
where
K: Into<ResponseHeadersKey>,
{
self.headers
.get(&key.into())
.and_then(|data| Some(data.clone()))
}
/// Retrieves the body content of the object as a UTF-8 encoded string.
///
/// This method uses `String::from_utf8_lossy` to convert the byte slice returned by `self.get_body()` into a string.
/// If the byte slice contains invalid UTF-8 sequences, they will be replaced with the Unicode replacement character (�).
///
/// # Returns
/// A `String` containing the body content.
pub fn get_body_string(&self) -> String {
String::from_utf8_lossy(self.get_body()).into_owned()
}
/// Deserializes the body content of the object into a specified type `T`.
///
/// This method first retrieves the body content as a UTF-8 encoded string using `self.get_body()`.
/// It then attempts to deserialize the string into the specified type `T` using `serde_json::from_str`.
///
/// # Type Parameters
/// - `T`: The target type to deserialize into. It must implement the `DeserializeOwned` trait.
///
/// # Returns
/// - `Ok(T)`: The deserialized object of type `T` if the deserialization is successful.
/// - `Err(serde_json::Error)`: An error if the deserialization fails (e.g., invalid JSON format or type mismatch).
pub fn get_body_json<T>(&self) -> ResultSerdeJsonError<T>
where
T: DeserializeOwned,
{
json_parse_from_slice(self.get_body())
}
/// Adds a header to the response.
///
/// This function inserts a key-value pair into the response headers.
/// The key and value are converted into `ResponseHeadersKey`, allowing for efficient handling of both owned and borrowed string data.
///
/// # Parameters
/// - `key`: The header key, which will be converted into a `ResponseHeadersKey`.
/// - `value`: The value of the header, which will be converted into a `ResponseHeadersValue`.
///
/// # Returns
/// - Returns a mutable reference to the current instance (`&mut Self`), allowing for method chaining.
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self
where
K: Into<ResponseHeadersKey>,
V: Into<ResponseHeadersValue>,
{
self.headers.insert(key.into(), value.into());
self
}
/// Set the body of the response.
///
/// This method allows you to set the body of the response by converting the provided
/// value into a `ResponseBody` type. The `body` is updated with the converted value,
/// and the method returns a mutable reference to the current instance for method chaining.
///
/// # Parameters
/// - `body`: The body of the response to be set. It can be any type that can be converted
/// into a `ResponseBody` using the `Into` trait.
///
/// # Return Value
/// - Returns a mutable reference to the current instance of the struct, enabling method chaining.
/// Set the body of the response.
///
/// This method allows you to set the body of the response by converting the provided
/// value into a `ResponseBody` type. The `body` is updated with the converted value,
/// and the method returns a mutable reference to the current instance for method chaining.
///
/// # Parameters
/// - `body`: The body of the response to be set. It can be any type that can be converted
/// into a `ResponseBody` using the `Into` trait.
///
/// # Return Value
/// - Returns a mutable reference to the current instance of the struct, enabling method chaining.
pub fn set_body<T: Into<ResponseBody>>(&mut self, body: T) -> &mut Self {
self.body = body.into();
self
}
/// Set the reason phrase of the response.
///
/// This method allows you to set the reason phrase of the response by converting the
/// provided value into a `ResponseReasonPhrase` type. The `reason_phrase` is updated
/// with the converted value, and the method returns a mutable reference to the current
/// instance for method chaining.
///
/// # Parameters
/// - `reason_phrase`: The reason phrase to be set for the response. It can be any type
/// that can be converted into a `ResponseReasonPhrase` using the `Into` trait.
///
/// # Return Value
/// - Returns a mutable reference to the current instance of the struct, enabling method chaining.
pub fn set_reason_phrase<T: Into<ResponseReasonPhrase>>(
&mut self,
reason_phrase: T,
) -> &mut Self {
self.reason_phrase = reason_phrase.into();
self
}
/// Pushes a header with a key and value into the response string.
///
/// # Parameters
/// - `response_string`: A mutable reference to the string where the header will be added.
/// - `key`: The header key as a string slice (`&str`).
/// - `value`: The header value as a string slice (`&str`).
pub(super) fn push_header(response_string: &mut String, key: &str, value: &str) {
response_string.push_str(&format!("{}{}{}{}", key, COLON_SPACE, value, HTTP_BR));
}
/// Pushes the first line of an HTTP response (version, status code, and reason phrase) into the response string.
/// This corresponds to the status line of the HTTP response.
///
/// # Parameters
/// - `response_string`: A mutable reference to the string where the first line will be added.
pub(super) fn push_http_response_first_line(&self, response_string: &mut String) {
response_string.push_str(&format!(
"{}{}{}{}{}{}",
self.get_version(),
SPACE,
self.get_status_code(),
SPACE,
self.get_reason_phrase(),
HTTP_BR
));
}
/// Builds the full HTTP response as a byte vector.
/// # Returns
/// - `ResponseData`: response data
pub(super) fn build(&mut self) -> ResponseData {
if self.reason_phrase.is_empty() {
self.set_reason_phrase(HttpStatus::phrase(*self.get_status_code()));
}
let mut response_string: String = String::new();
self.push_http_response_first_line(&mut response_string);
let mut compress_type_opt: OptionCompress = None;
let mut connection_opt: OptionString = None;
let mut content_type_opt: OptionString = None;
let headers: ResponseHeaders = self
.get_mut_headers()
.drain()
.map(|(key, value)| (key.to_lowercase(), value))
.collect();
let mut unset_content_length: bool = false;
for (key, value) in headers.iter() {
if key == CONTENT_LENGTH {
continue;
} else if key == CONTENT_ENCODING {
compress_type_opt = Some(value.parse::<Compress>().unwrap_or_default());
} else if key == CONNECTION {
connection_opt = Some(value.to_owned());
} else if key == CONTENT_TYPE {
content_type_opt = Some(value.to_owned());
if value.to_ascii_lowercase() == TEXT_EVENT_STREAM {
unset_content_length = true;
}
}
Self::push_header(&mut response_string, key, value);
}
if connection_opt.is_none() {
Self::push_header(&mut response_string, CONNECTION, CONNECTION_KEEP_ALIVE);
}
if content_type_opt.is_none() {
Self::push_header(
&mut response_string,
CONTENT_TYPE,
&format!("{}{}{}", TEXT_HTML, SEMICOLON_SPACE, CHARSET_UTF_8),
);
}
let mut body: Cow<Vec<u8>> = Cow::Borrowed(self.get_body());
if !unset_content_length {
if let Some(compress_type) = compress_type_opt {
if !compress_type.is_unknown() {
let tmp_body: Cow<'_, Vec<u8>> =
compress_type.encode(&body, DEFAULT_BUFFER_SIZE);
body = Cow::Owned(tmp_body.into_owned());
}
}
let len_string: String = body.len().to_string();
Self::push_header(&mut response_string, CONTENT_LENGTH, &len_string);
}
response_string.push_str(HTTP_BR);
let mut response_bytes: Vec<u8> = response_string.into_bytes();
response_bytes.extend_from_slice(&body);
response_bytes
}
/// Sends the HTTP response body over a TCP stream.
///
/// # Parameters
/// - `stream`: A mutable reference to the `TcpStream` to send the response.
/// - `is_websocket`: Is websocket
///
/// # Returns
/// - `Ok`: If the response body is successfully sent.
/// - `Err`: If an error occurs during sending.
pub async fn send_body(
&mut self,
stream_lock: &ArcRwLockStream,
is_websocket: bool,
) -> ResponseResult {
stream_lock.send_body(self.get_body(), is_websocket).await
}
/// Sends the HTTP response over a TCP stream.
///
/// # Parameters
/// - `stream`: A mutable reference to the `TcpStream` to send the response.
///
/// # Returns
/// - `Ok`: If the response is successfully sent.
/// - `Err`: If an error occurs during sending.
pub async fn send(&mut self, stream_lock: &ArcRwLockStream) -> ResponseResult {
stream_lock.send(&self.build()).await
}
/// Flush the TCP stream.
///
/// - `stream_lock`: A reference to an `ArcRwLockStream` that manages the TCP stream.
///
/// - Returns: A `ResponseResult` indicating success or failure.
pub async fn flush(&mut self, stream_lock: &ArcRwLockStream) -> ResponseResult {
stream_lock.flush().await
}
/// Closes the stream after sending the response.
///
/// This function is responsible for:
/// - Building the response using the `build()` method.
/// - Setting the response using the `set_response()` method.
/// - Shutting down the write half of the TCP stream to indicate no more data will be sent.
///
/// # Parameters
/// - `stream`: A reference to the `TcpStream` that will be closed after sending the response.
///
/// # Returns
/// - `ResponseResult`: The result of the operation, indicating whether the closure was successful or if an error occurred.
pub async fn close(&mut self, stream_lock: &ArcRwLockStream) -> ResponseResult {
stream_lock.close().await
}
/// Converts the response to a formatted string representation.
///
/// - Returns: A `String` containing formatted response details.
pub fn get_string(&self) -> String {
let body: &Vec<u8> = self.get_body();
format!(
"[Response] => [Version]: {}; [Status Code]: {}; [Reason]: {}; [Headers]: {:?}; [Body]: {};",
self.get_version(),
self.get_status_code(),
self.get_reason_phrase(),
self.get_headers(),
body_to_string(body),
)
}
}