Struct Request 

pub struct Request {
    pub method: Method,
    pub host: String,
    pub version: HttpVersion,
    pub path: String,
    pub querys: HashMap<String, String, BuildHasherDefault<Hasher>>,
    pub headers: HashMap<String, VecDeque<String>, BuildHasherDefault<Hasher>>,
    pub body: Vec<u8>,
}

HTTP request representation.

Contains all components of an HTTP request.

Fields

method: Method

HTTP request method.

host: String

Request host.

version: HttpVersion

HTTP protocol version.

path: String

Request path.

querys: HashMap<String, String, BuildHasherDefault<Hasher>>

URL query parameters.

headers: HashMap<String, VecDeque<String>, BuildHasherDefault<Hasher>>

HTTP headers collection.

body: Vec<u8>

Request body content.

Implementations

impl Request

pub fn try_get_query<K>(&self, key: K) -> Option<String>

where K: AsRef<str>,

Tries to get a query parameter value by key.

The key type must implement AsRef conversion.

Arguments

• AsRef<str> - The query parameter key (implements AsRef).

Returns

• Option<RequestQuerysValue> - The parameter value if exists.

pub fn get_query<K>(&self, key: K) -> String

where K: AsRef<str>,

Gets a query parameter value by key.

The key type must implement AsRef conversion.

Arguments

• AsRef<str> - The query parameter key (implements AsRef).

Returns

• RequestQuerysValue - The parameter value if exists.

Panics

This function will panic if the query parameter key is not found.

pub fn try_get_header<K>(&self, key: K) -> Option<VecDeque<String>>

where K: AsRef<str>,

Tries to retrieve the value of a request header by its key.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• Option<RequestHeadersValue> - The optional header values.

pub fn get_header<K>(&self, key: K) -> VecDeque<String>

where K: AsRef<str>,

Retrieves the value of a request header by its key.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• RequestHeadersValue - The optional header values.

Panics

This function will panic if the header key is not found.

pub fn try_get_header_front<K>(&self, key: K) -> Option<String>

where K: AsRef<str>,

Tries to retrieve the first value of a request header by its key.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• Option<RequestHeadersValueItem> - The first header value if exists.

pub fn get_header_front<K>(&self, key: K) -> String

where K: AsRef<str>,

Retrieves the first value of a request header by its key.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• RequestHeadersValueItem - The first header value if exists.

Panics

This function will panic if the header key is not found.

pub fn try_get_header_back<K>(&self, key: K) -> Option<String>

where K: AsRef<str>,

Tries to retrieve the last value of a request header by its key.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• Option<RequestHeadersValueItem> - The last header value if exists.

pub fn get_header_back<K>(&self, key: K) -> String

where K: AsRef<str>,

Retrieves the last value of a request header by its key.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• RequestHeadersValueItem - The last header value if exists.

Panics

This function will panic if the header key is not found.

pub fn try_get_header_size<K>(&self, key: K) -> Option<usize>

where K: AsRef<str>,

Tries to retrieve the number of values for a specific header.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• Option<usize> - The count of values for the header if exists.

pub fn get_header_size<K>(&self, key: K) -> usize

where K: AsRef<str>,

Retrieves the number of values for a specific header.

Arguments

• AsRef<str> - The header’s key (must implement AsRef).

Returns

• usize - The count of values for the header.

Panics

This function will panic if the header key is not found.

pub fn get_headers_values_size(&self) -> usize

Retrieves the total number of header values across all headers.

Returns

• usize - The total count of all header values.

pub fn get_headers_size(&self) -> usize

Retrieves the number of unique headers.

Returns

• usize - The count of unique header keys.

pub fn has_header<K>(&self, key: K) -> bool

where K: AsRef<str>,

Checks if a specific header exists.

Arguments

• AsRef<str> - The header key to check (must implement AsRef).

Returns

• bool - Whether the header exists.

pub fn has_header_value<K, V>(&self, key: K, value: V) -> bool

where K: AsRef<str>, V: AsRef<str>,

Checks if a header contains a specific value.

Arguments

• AsRef<str> - The header key to check (must implement AsRef).
• AsRef<str> - The value to search for (must implement AsRef).

Returns

• bool - Whether the header contains the value.

pub fn try_get_cookies( &self, ) -> Option<HashMap<String, String, BuildHasherDefault<Hasher>>>

Tries to parse cookies from the Cookie header.

This method retrieves the Cookie header value and parses it into a collection of key-value pairs representing the cookies.

Returns

• Option<Cookies> - The parsed cookies if the header exists, otherwise None.

pub fn get_cookies(&self) -> HashMap<String, String, BuildHasherDefault<Hasher>>

Parses cookies from the Cookie header.

This method retrieves the Cookie header value and parses it into a collection of key-value pairs representing the cookies.

Returns

• Cookies - The parsed cookies.

Panics

This function will panic if the Cookie header is not found.

pub fn try_get_cookie<K>(&self, key: K) -> Option<String>

where K: AsRef<str>,

Tries to get a cookie value by its key.

This method first parses the cookies from the Cookie header, then attempts to retrieve the value for the specified key.

Arguments

• AsRef<str> - The cookie key (implements AsRef).

Returns

• Option<CookieValue> - The cookie value if exists.

pub fn get_cookie<K>(&self, key: K) -> String

where K: AsRef<str>,

Gets a cookie value by its key.

This method first parses the cookies from the Cookie header, then retrieves the value for the specified key.

Arguments

• AsRef<str> - The cookie key (implements AsRef).

Returns

• CookieValue - The cookie value.

Panics

This function will panic if the Cookie header is not found or the cookie key does not exist.

pub fn get_upgrade_type(&self) -> UpgradeType

Retrieves the upgrade type from the request headers.

This method looks for the UPGRADE header and attempts to parse its value as_ref an UpgradeType. If the header is missing or the value is invalid, it returns the default UpgradeType.

Returns

• UpgradeType - The parsed upgrade type.

pub fn get_body_string(&self) -> String

Retrieves the body content of the request as a UTF-8 encoded string.

This method uses String::from_utf8_lossy to convert the byte slice returned by self.get_body() as a string. If the byte slice contains invalid UTF-8 sequences, they will be replaced with the Unicode replacement character ().

Returns

• String - The body content as a string.

pub fn try_get_body_json<T>(&self) -> Result<T, Error>

where T: DeserializeOwned,

Deserializes the body content of the request as_ref a specified type T.

This method first retrieves the body content as a byte slice using self.get_body(). It then attempts to deserialize the byte slice as_ref the specified type T using json_from_slice.

Arguments

• DeserializeOwned - The target type to deserialize as_ref (must implement DeserializeOwned).

Returns

• Result<T, serde_json::Error> - The deserialization result.

pub fn get_body_json<T>(&self) -> T

where T: DeserializeOwned,

Deserializes the body content of the request as_ref a specified type T.

This method first retrieves the body content as a byte slice using self.get_body(). It then attempts to deserialize the byte slice as_ref the specified type T using json_from_slice.

Arguments

• DeserializeOwned - The target type to deserialize as_ref (must implement DeserializeOwned).

Returns

• T - The deserialized body content.

Panics

This function will panic if the deserialization fails.

pub fn is_ws_upgrade_type(&self) -> bool

Checks whether the WebSocket upgrade is enabled for this request.

This method determines if the UPGRADE header indicates a WebSocket connection.

Returns

• bool - Whether WebSocket upgrade is enabled.

pub fn is_h2c_upgrade_type(&self) -> bool

Checks if the current upgrade type is HTTP/2 cleartext (h2c).

Returns

• bool - Whether the upgrade type is h2c.

pub fn is_tls_upgrade_type(&self) -> bool

Checks if the current upgrade type is TLS (any version).

Returns

• bool - Whether the upgrade type is TLS.

pub fn is_unknown_upgrade_type(&self) -> bool

Checks whether the upgrade type is unknown.

Returns

• bool - Whether the upgrade type is unknown.

pub fn is_enable_keep_alive(&self) -> bool

Determines if a keep-alive connection should be enabled for this request.

This function checks the Connection header and the HTTP version to determine if keep-alive should be enabled. The logic is as follows:

1. If the Connection header exists:
   • Returns true if the header value is “keep-alive” (case-insensitive).
   • Returns false if the header value is “close” (case-insensitive).
2. If no Connection header is present:
   • Returns true if the HTTP version is 1.1 or higher.
   • Returns false otherwise.

Returns

• bool - Whether keep-alive should be enabled.

pub fn is_disable_keep_alive(&self) -> bool

Determines if keep-alive should be disabled for this request.

Returns

• bool - Whether keep-alive should be disabled.

impl Request

pub fn get_method(&self) -> &Method

pub fn get_host(&self) -> &String

pub fn get_version(&self) -> &HttpVersion

pub fn get_path(&self) -> &String

pub fn get_querys(&self) -> &HashMap<String, String, BuildHasherDefault<Hasher>>

pub fn get_headers( &self, ) -> &HashMap<String, VecDeque<String>, BuildHasherDefault<Hasher>>

pub fn get_body(&self) -> &Vec<u8>

impl Request

pub fn get_mut_method(&mut self) -> &mut Method

pub fn get_mut_host(&mut self) -> &mut String

pub fn get_mut_version(&mut self) -> &mut HttpVersion

pub fn get_mut_path(&mut self) -> &mut String

pub fn get_mut_querys( &mut self, ) -> &mut HashMap<String, String, BuildHasherDefault<Hasher>>

pub fn get_mut_headers( &mut self, ) -> &mut HashMap<String, VecDeque<String>, BuildHasherDefault<Hasher>>

pub fn get_mut_body(&mut self) -> &mut Vec<u8>

impl Request

pub fn set_method(&mut self, val: Method) -> &mut Request

pub fn set_host(&mut self, val: String) -> &mut Request

pub fn set_version(&mut self, val: HttpVersion) -> &mut Request

pub fn set_path(&mut self, val: String) -> &mut Request

pub fn set_querys( &mut self, val: HashMap<String, String, BuildHasherDefault<Hasher>>, ) -> &mut Request

pub fn set_headers( &mut self, val: HashMap<String, VecDeque<String>, BuildHasherDefault<Hasher>>, ) -> &mut Request

pub fn set_body(&mut self, val: Vec<u8>) -> &mut Request

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Request

Provides a default value for Request.

Returns a new Request instance with all fields initialized to their default values.

fn default() -> Request

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>( __deserializer: __D, ) -> Result<Request, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for Request

fn eq(&self, other: &Request) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Request

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Request

impl StructuralPartialEq for Request