http-type 3.0.0

A library providing essential types for HTTP, including request bodies, response headers, and other core HTTP abstractions.
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

use super::error::Error as RequestError;
use lombok_macros::*;
use std::collections::HashMap;

/// RequestMethod
pub type RequestMethod = String;

/// RequestHost
pub type RequestHost = String;

/// RequestPath
pub type RequestPath = String;

/// RequestQuery
pub type RequestQuery = HashMap<String, String>;

///  RequestBody
pub type RequestBody = Vec<u8>;

/// RequestHeaders
pub type RequestHeaders = HashMap<String, String>;

/// RequestNewResult
pub type RequestNewResult = Result<Request, RequestError>;

/// Represents an HTTP request.
///
/// # Fields
/// - `method`: The HTTP method of the request (e.g., GET, POST).
/// - `host`: The host of the request (e.g., example.com).
/// - `path`: The path of the request (e.g., /api/v1/resource).
/// - `query`: The query string of the request (e.g., ?key=value).
/// - `headers`: A collection of HTTP headers as key-value pairs.
/// - `body`: The binary body of the request.
#[derive(Debug, Clone, Lombok, PartialEq, Eq)]
pub struct Request {
    #[set(skip)]
    pub(crate) method: RequestMethod,
    #[set(skip)]
    pub(crate) host: RequestHost,
    #[set(skip)]
    pub(crate) path: RequestPath,
    #[set(skip)]
    pub(crate) query: RequestQuery,
    pub(crate) headers: RequestHeaders,
    #[set(skip)]
    pub(crate) body: RequestBody,
}