Struct Request 

pub struct Request { /* private fields */ }

HTTP request representation.

Contains all components of an HTTP request.

Implementations

impl Request

pub async fn http_from_stream( stream: &ArcRwLockStream, config: &RequestConfigData, ) -> Result<Request, RequestError>

Parses an HTTP request from a TCP stream.

Wraps the stream in a buffered reader and delegates to http_from_reader. If the timeout is DEFAULT_LOW_SECURITY_HTTP_READ_TIMEOUT_MS, no timeout is applied.

Arguments

• &ArcRwLock<TcpStream> - The TCP stream to read from.
• &RequestConfigData - Configuration for security limits and buffer settings.

Returns

• Result<Request, RequestError> - The parsed request or an error.

pub async fn ws_from_stream( &self, stream: &ArcRwLockStream, config: &RequestConfigData, ) -> Result<Request, RequestError>

Parses a WebSocket request from a TCP stream.

Wraps the stream in a buffered reader and delegates to ws_from_reader. If the timeout is DEFAULT_LOW_SECURITY_WS_READ_TIMEOUT_MS, no timeout is applied.

Arguments

• &ArcRwLock<TcpStream>: The TCP stream to read from.
• &RequestConfigData: Configuration for security limits and buffer settings.

Returns

• Result<Request, RequestError>: The parsed WebSocket request or an error.

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

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) -> RequestQuerysValue

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<RequestHeadersValue>

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) -> RequestHeadersValue

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<RequestHeadersValueItem>

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) -> RequestHeadersValueItem

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<RequestHeadersValueItem>

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) -> RequestHeadersValueItem

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 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_ref 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_get_method(&self) -> bool

Checks whether the request method is GET.

Returns

• bool - Whether the method is GET.

pub fn is_post_method(&self) -> bool

Checks whether the request method is POST.

Returns

• bool - Whether the method is POST.

pub fn is_put_method(&self) -> bool

Checks whether the request method is PUT.

Returns

• bool - Whether the method is PUT.

pub fn is_delete_method(&self) -> bool

Checks whether the request method is DELETE.

Returns

• bool - Whether the method is DELETE.

pub fn is_patch_method(&self) -> bool

Checks whether the request method is PATCH.

Returns

• bool - Whether the method is PATCH.

pub fn is_head_method(&self) -> bool

Checks whether the request method is HEAD.

Returns

• bool - Whether the method is HEAD.

pub fn is_options_method(&self) -> bool

Checks whether the request method is OPTIONS.

Returns

• bool - Whether the method is OPTIONS.

pub fn is_connect_method(&self) -> bool

Checks whether the request method is CONNECT.

Returns

• bool - Whether the method is CONNECT.

pub fn is_trace_method(&self) -> bool

Checks whether the request method is TRACE.

Returns

• bool - Whether the method is TRACE.

pub fn is_unknown_method(&self) -> bool

Checks whether the request method is UNKNOWN.

Returns

• bool - Whether the method is UNKNOWN.

pub fn is_http0_9_version(&self) -> bool

Checks whether the HTTP version is HTTP/0.9.

Returns

• bool - Whether the version is HTTP/0.9.

pub fn is_http1_0_version(&self) -> bool

Checks whether the HTTP version is HTTP/1.0.

Returns

• bool - Whether the version is HTTP/1.0.

pub fn is_http1_1_version(&self) -> bool

Checks whether the HTTP version is HTTP/1.1.

Returns

• bool - Whether the version is HTTP/1.1.

pub fn is_http1_1_or_higher_version(&self) -> bool

Checks if the HTTP version is HTTP/1.1 or higher.

Returns

• bool - Whether the version is HTTP/1.1 or higher.

pub fn is_http2_version(&self) -> bool

Checks whether the HTTP version is HTTP/2.

Returns

• bool - Whether the version is HTTP/2.

pub fn is_http3_version(&self) -> bool

Checks whether the HTTP version is HTTP/3.

Returns

• bool - Whether the version is HTTP/3.

pub fn is_unknown_version(&self) -> bool

Checks whether the HTTP version is unknown.

Returns

• bool - Whether the version is unknown.

pub fn is_http_version(&self) -> bool

Checks whether the version belongs to the HTTP family.

Returns

• bool - Whether the version is HTTP.

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.

pub fn try_json_vec(&self) -> Result<Vec<u8>, Error>

Serializes the request to a JSON byte vector.

This method attempts to serialize the entire request structure into a JSON formatted byte vector representation.

Returns

• Result<Vec<u8>, serde_json::Error> - The serialized JSON bytes on success, or a serialization error on failure.

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

Serializes the request to a JSON byte vector.

This method serializes the entire request structure into a JSON formatted byte vector representation.

Returns

• Vec<u8> - The serialized JSON bytes.

Panics

This function will panic if the serialization fails.

pub fn try_json_string(&self) -> Result<String, Error>

Serializes the request to a JSON string.

This method attempts to serialize the entire request structure into a JSON formatted string representation.

Returns

• Result<String, serde_json::Error> - The serialized JSON string on success, or a serialization error on failure.

pub fn json_string(&self) -> String

Serializes the request to a JSON string.

This method serializes the entire request structure into a JSON formatted string representation.

Returns

• String - The serialized JSON string.

Panics

This function will panic if the serialization fails.

impl Request

pub fn get_method(&self) -> &RequestMethod

pub fn get_host(&self) -> &RequestHost

pub fn get_version(&self) -> &RequestVersion

pub fn get_path(&self) -> &RequestPath

pub fn get_querys(&self) -> &RequestQuerys

pub fn get_headers(&self) -> &RequestHeaders

pub fn get_body(&self) -> &RequestBody

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

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() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Request

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

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Request

impl StructuralPartialEq for Request