http_wire 0.7.0

Serialize HTTP requests and responses to wire format bytes
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
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
//! HTTP response encoding and decoding.
//!
//! This module handles the serialization of `http::Response` objects into wire-format bytes
//! and the parsing of raw bytes to determine response boundaries.
//!
//! # Response Encoding
//!
//! The [`WireEncode`] trait is implemented for [`http::Response`],
//! allowing you to serialize responses to bytes via direct serialization
//! (no async runtime, no HTTP pipeline, no `Clone` constraint on the body).
//!
//! ```rust
//! use http_wire::WireEncode;
//! use http::Response;
//! use http_body_util::Full;
//! use bytes::Bytes;
//!
//! let response = Response::new(Full::new(Bytes::from("Hello")));
//! let wire_bytes = response.encode().unwrap();
//! ```
//!
//! # Response Decoding
//!
//! Use [`FullResponse`] to decode HTTP responses from raw bytes.

use bytes::{Bytes, BytesMut};

pub use httparse::{Header, Response};

use crate::error::WireError;
use crate::util::{chunked_body_len, is_chunked_slice, version_to_str};
use crate::{WireDecode, WireEncode};

impl<B> WireEncode for http::Response<B>
where
    B: http_body_util::BodyExt,
    B::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
{
    fn encode(self) -> Result<Bytes, WireError> {
        let version = self.version();
        if version != http::Version::HTTP_11 && version != http::Version::HTTP_10 {
            return Err(WireError::UnsupportedVersion);
        }

        let (parts, body) = self.into_parts();
        let status = parts.status;
        let reason = status.canonical_reason().unwrap_or("Unknown");

        // Collect body bytes synchronously.
        // Works for any body type whose future completes without an async I/O driver
        // (e.g. `Full<Bytes>`, `Empty<Bytes>`).
        let body_bytes = futures::executor::block_on(body.collect())
            .map_err(|e| WireError::Collection(e.into()))?
            .to_bytes();

        // Pre-allocate a rough estimate: 48 bytes per header covers name + value
        // in the typical case; 16 bytes of fixed overhead absorbs the status line,
        // separators and the blank line. Both are intentionally coarse — the point
        // is to avoid the most common reallocations, not to be exact.
        let mut buf = BytesMut::with_capacity(
            parts.headers.len() * 48 + body_bytes.len() + 16,
        );

        // Status line: HTTP-version SP status-code SP reason-phrase CRLF
        buf.extend_from_slice(version_to_str(version).as_bytes());
        buf.extend_from_slice(b" ");
        buf.extend_from_slice(status.as_str().as_bytes());
        buf.extend_from_slice(b" ");
        buf.extend_from_slice(reason.as_bytes());
        buf.extend_from_slice(b"\r\n");

        // Header fields
        for (name, value) in &parts.headers {
            buf.extend_from_slice(name.as_str().as_bytes());
            buf.extend_from_slice(b": ");
            buf.extend_from_slice(value.as_bytes());
            buf.extend_from_slice(b"\r\n");
        }

        // Header/body separator
        buf.extend_from_slice(b"\r\n");

        // Body
        buf.extend_from_slice(&body_bytes);

        Ok(buf.freeze())
    }
}

/// Decoder for extracting HTTP response status code and message length.
///
/// Returns `(StatusCode, usize)` containing the status code and total length in bytes
/// of a complete HTTP response (headers + body), or `None` if incomplete or malformed.
///
/// Correctly handles status codes without bodies (1xx, 204, 304), `Content-Length`,
/// and `Transfer-Encoding: chunked`.
///
/// # Example
///
/// ```rust
/// use http_wire::WireDecode;
/// use http_wire::response::FullResponse;
///
/// let raw = b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nhello";
/// let mut headers = [httparse::EMPTY_HEADER; 16];
/// let (full_response, length) = FullResponse::decode(raw, &mut headers).unwrap();
/// assert_eq!(full_response.head.code, Some(200));
/// assert_eq!(length, raw.len());
/// ```
pub struct FullResponse<'headers, 'buf> {
    /// The parsed HTTP response headers and status line.
    ///
    /// Contains the HTTP version, status code, reason phrase, and headers.
    /// Use `head.code` to access the status code, `head.reason` for the reason phrase,
    /// and `head.headers` to iterate over the headers.
    pub head: httparse::Response<'headers, 'buf>,
    /// The response body as a byte slice.
    ///
    /// This is a reference into the original buffer passed to [`parse`](Self::parse)
    /// or [`decode`](WireDecode::decode). It contains the complete body content
    /// after decoding any transfer encodings (chunked or content-length).
    pub body: &'buf [u8],
}

impl<'headers, 'buf> FullResponse<'headers, 'buf> {
    /// Parse an HTTP response from raw bytes.
    ///
    /// This method parses the HTTP response from the provided buffer, extracting
    /// the status code, headers, and body. It correctly handles responses with
    /// no body (1xx, 204, 304), `Content-Length` specified bodies, and
    /// `Transfer-Encoding: chunked` bodies.
    ///
    /// # Arguments
    ///
    /// * `buf` - The buffer containing the raw HTTP response bytes
    ///
    /// # Returns
    ///
    /// Returns `Ok(total_len)` where `total_len` is the complete message length (headers + body).
    ///
    /// # Errors
    ///
    /// Returns [`WireError::PartialHead`] if headers are incomplete,
    /// [`WireError::HttparseError`] if header parsing fails,
    /// [`WireError::InvalidChunkedBody`] if chunked encoding is malformed,
    /// or [`WireError::IncompleteBody`] if the body is shorter than specified by `Content-Length`.
    pub fn parse(&mut self, buf: &'buf [u8]) -> Result<usize, WireError> {
        match self.head.parse(buf) {
            Ok(httparse::Status::Complete(headers_len)) => {
                let code = self.head.code.unwrap_or(200);

                // Fast path for responses that never have a body (1xx, 204, 304)
                if code == 204 || code == 304 || (100..200).contains(&code) {
                    self.body = &[];
                    return Ok(headers_len);
                }

                let mut content_len: Option<usize> = None;
                let mut is_chunked = false;

                // Scan headers for Content-Length or Transfer-Encoding
                for header in self.head.headers.iter() {
                    let name = header.name.as_bytes();
                    if name.len() == 14 && name.eq_ignore_ascii_case(b"Content-Length") {
                        content_len = std::str::from_utf8(header.value)
                            .ok()
                            .and_then(|s| s.parse().ok());
                    } else if name.len() == 17 && name.eq_ignore_ascii_case(b"Transfer-Encoding") {
                        is_chunked = is_chunked_slice(header.value);
                    }
                }

                // Calculate body length
                if is_chunked {
                    let body_len = chunked_body_len(&buf[headers_len..])
                        .ok_or(WireError::InvalidChunkedBody)?;
                    self.body = &buf[headers_len..headers_len + body_len];
                    Ok(headers_len + body_len)
                } else {
                    // If content-length is missing, length is 0
                    let body_len = content_len.unwrap_or(0);
                    let total = headers_len + body_len;
                    if buf.len() >= total {
                        self.body = &buf[headers_len..total];
                        Ok(total)
                    } else {
                        Err(WireError::IncompleteBody(total - buf.len()))
                    }
                }
            }
            Ok(httparse::Status::Partial) => Err(WireError::PartialHead),
            Err(err) => Err(err.into()),
        }
    }
}

impl<'headers, 'buf> WireDecode<'headers, 'buf> for FullResponse<'headers, 'buf> {
    fn decode(
        buf: &'buf [u8],
        headers: &'headers mut [Header<'buf>],
    ) -> Result<(Self, usize), WireError> {
        let mut full_response = FullResponse {
            head: httparse::Response::new(headers),
            body: &[],
        };

        let total = full_response.parse(buf)?;
        Ok((full_response, total))
    }

    // decode_uninit is not implemented for FullResponse because httparse::Response
    // does not provide parse_with_uninit_headers method.
    // The default implementation will panic with an appropriate message.
}

#[cfg(test)]
mod tests {
    use super::*;
    use bytes::Bytes;
    use http_body_util::{Empty, Full};

    // ── Encoding ────────────────────────────────────────────────────────────

    #[test]
    fn test_response_encode_200() {
        let response = http::Response::builder()
            .status(200)
            .header("Content-Type", "text/plain")
            .body(Full::new(Bytes::from("Hello")))
            .unwrap();

        let bytes = response.encode().unwrap();
        let output = String::from_utf8_lossy(&bytes);

        assert!(output.starts_with("HTTP/1.1 200 OK\r\n"));
        assert!(output.contains("content-type: text/plain\r\n"));
        assert!(output.contains("\r\n\r\n"));
        assert!(output.ends_with("Hello"));
    }

    #[test]
    fn test_response_encode_404() {
        let response = http::Response::builder()
            .status(404)
            .body(Full::new(Bytes::from("Not Found")))
            .unwrap();

        let bytes = response.encode().unwrap();
        let output = String::from_utf8_lossy(&bytes);

        assert!(output.starts_with("HTTP/1.1 404 Not Found\r\n"));
        assert!(output.ends_with("Not Found"));
    }

    #[test]
    fn test_response_encode_no_body() {
        let response = http::Response::builder()
            .status(204)
            .header("Server", "http_wire")
            .body(Empty::<Bytes>::new())
            .unwrap();

        let bytes = response.encode().unwrap();
        let output = String::from_utf8_lossy(&bytes);

        assert!(output.starts_with("HTTP/1.1 204 No Content\r\n"));
        assert!(output.contains("server: http_wire\r\n"));
        // Body must be empty after the separator
        let parts: Vec<&str> = output.splitn(2, "\r\n\r\n").collect();
        assert_eq!(parts.len(), 2);
        assert!(parts[1].is_empty());
    }

    #[test]
    fn test_response_encode_http10() {
        let response = http::Response::builder()
            .status(200)
            .version(http::Version::HTTP_10)
            .body(Empty::<Bytes>::new())
            .unwrap();

        let bytes = response.encode().unwrap();
        let output = String::from_utf8_lossy(&bytes);

        assert!(output.starts_with("HTTP/1.0 200 OK\r\n"));
    }

    #[test]
    fn test_response_encode_http2_rejected() {
        let response = http::Response::builder()
            .status(200)
            .version(http::Version::HTTP_2)
            .body(Full::new(Bytes::from("Hello")))
            .unwrap();

        let result = response.encode();
        assert!(matches!(result, Err(WireError::UnsupportedVersion)));
    }

    #[test]
    fn test_response_encode_header_body_separator() {
        let body = "Hello World";
        let response = http::Response::builder()
            .status(200)
            .header("Content-Type", "text/plain")
            .body(Full::new(Bytes::from(body)))
            .unwrap();

        let bytes = response.encode().unwrap();
        let output = String::from_utf8_lossy(&bytes);

        // Headers and body must be separated by exactly \r\n\r\n
        assert!(output.contains("\r\n\r\n"));
        let parts: Vec<&str> = output.splitn(2, "\r\n\r\n").collect();
        assert_eq!(parts.len(), 2, "response must have a headers section and a body section");
        assert_eq!(parts[1], body, "body must appear verbatim after the separator");
    }

    #[test]
    fn test_response_encode_multiple_headers() {
        let response = http::Response::builder()
            .status(200)
            .header("Content-Type", "application/json")
            .header("X-Request-Id", "abc-123")
            .header("Cache-Control", "no-cache")
            .body(Empty::<Bytes>::new())
            .unwrap();

        let bytes = response.encode().unwrap();
        let output = String::from_utf8_lossy(&bytes);

        assert!(output.contains("content-type: application/json\r\n"));
        assert!(output.contains("x-request-id: abc-123\r\n"));
        assert!(output.contains("cache-control: no-cache\r\n"));
    }

    // ── Decoding ─────────────────────────────────────────────────────────────

    #[test]
    fn test_decode_response_no_body() {
        let raw = b"HTTP/1.1 204 No Content\r\nServer: test\r\n\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(204));
        assert_eq!(len, raw.len());
        assert_eq!(response.body.len(), 0);
    }

    #[test]
    fn test_decode_response_with_content_length() {
        let raw = b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nhello";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(200));
        assert_eq!(len, raw.len());
        assert_eq!(response.body, b"hello");
    }

    #[test]
    fn test_decode_response_incomplete_body() {
        // Content-Length says 10, but body is only 5 bytes
        let raw = b"HTTP/1.1 200 OK\r\nContent-Length: 10\r\n\r\nhello";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(matches!(result, Err(WireError::IncompleteBody(_))));
    }

    #[test]
    fn test_decode_response_incomplete_headers() {
        let raw = b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(matches!(result, Err(WireError::PartialHead)));
    }

    #[test]
    fn test_decode_response_chunked_encoding() {
        let raw = b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n5\r\nhello\r\n0\r\n\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(200));
        assert_eq!(len, raw.len());
    }

    #[test]
    fn test_decode_response_chunked_multiple_chunks() {
        let raw = b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n5\r\nhello\r\n6\r\n world\r\n0\r\n\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(200));
        assert_eq!(len, raw.len());
    }

    #[test]
    fn test_decode_response_chunked_incomplete() {
        // Missing final 0\r\n\r\n
        let raw = b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n5\r\nhello\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(matches!(result, Err(WireError::InvalidChunkedBody)));
    }

    #[test]
    fn test_decode_response_extra_data_after() {
        // Buffer has extra data after the response — decode should return correct length
        let response = b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nhello";
        let mut raw = response.to_vec();
        raw.extend_from_slice(b"extra garbage data");
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let (_, len) = FullResponse::decode(&raw, &mut headers).unwrap();
        assert_eq!(len, response.len());
    }

    #[test]
    fn test_decode_response_chunked_case_insensitive() {
        let raw = b"HTTP/1.1 200 OK\r\nTransfer-Encoding: CHUNKED\r\n\r\n5\r\nhello\r\n0\r\n\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(200));
        assert_eq!(len, raw.len());
    }

    #[test]
    fn test_decode_response_304_no_body() {
        // 304 responses never have a body
        let raw = b"HTTP/1.1 304 Not Modified\r\nETag: \"abc\"\r\n\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(304));
        assert_eq!(len, raw.len());
        assert_eq!(response.body.len(), 0);
    }

    #[test]
    fn test_decode_response_1xx_no_body() {
        // 1xx responses never have a body
        let raw = b"HTTP/1.1 100 Continue\r\n\r\n";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let result = FullResponse::decode(raw, &mut headers);
        assert!(result.is_ok());
        let (response, len) = result.unwrap();
        assert_eq!(response.head.code, Some(100));
        assert_eq!(len, raw.len());
        assert_eq!(response.body.len(), 0);
    }

    #[test]
    fn test_decode_response_fields_access() {
        let raw =
            b"HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 11\r\n\r\nHello World";
        let mut headers = [httparse::EMPTY_HEADER; 16];
        let (response, total_len) = FullResponse::decode(raw, &mut headers).unwrap();

        assert_eq!(response.head.code, Some(200));
        assert_eq!(response.head.reason, Some("OK"));
        assert_eq!(response.head.version, Some(1));

        assert_eq!(response.head.headers.len(), 2);
        assert_eq!(response.head.headers[0].name, "Content-Type");
        assert_eq!(response.head.headers[0].value, b"text/plain");
        assert_eq!(response.head.headers[1].name, "Content-Length");
        assert_eq!(response.head.headers[1].value, b"11");

        assert_eq!(response.body, b"Hello World");
        assert_eq!(total_len, raw.len());
    }

    #[test]
    #[should_panic(
        expected = "decode_uninit is not available for this type due to missing parse_with_uninit_headers method"
    )]
    fn test_decode_response_uninit_panics() {
        let raw = b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nhello";
        let mut headers = [const { std::mem::MaybeUninit::uninit() }; 16];
        let _result = FullResponse::decode_uninit(raw, &mut headers);
    }
}