Struct Request 

pub struct Request { /* private fields */ }

HTTP request representation.

Contains all components of an HTTP request.

Implementations

impl Request

pub fn new() -> Self

Creates a new instance of Request.

Returns

• Request - A new request instance with default values.

pub async fn http_from_reader( reader: &mut BufReader<&mut TcpStream>, buffer: usize, ) -> RequestReaderHandleResult

Parses an HTTP request from a buffered TCP stream reader.

Reads request line, headers and body from the stream and constructs a Request object.

Arguments

• &mut BufReader<&mut TcpStream> - The buffered TCP stream reader.
• usize - The buffer size for reading.

Returns

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

pub async fn http_from_stream( stream: &ArcRwLockStream, buffer: usize, ) -> RequestReaderHandleResult

Parses an HTTP request from a TCP stream.

Wraps the stream in a buffered reader and delegates to http_from_reader.

Arguments

• &ArcRwLock<TcpStream> - The TCP stream to read from.
• usize - The buffer size for reading.

Returns

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

pub async fn ws_from_stream( stream: &ArcRwLockStream, buffer: usize, request: &mut Self, ) -> RequestReaderHandleResult

Parses a WebSocket request from a TCP stream.

Wraps the stream in a buffered reader and delegates to ws_from_reader.

Arguments

• &ArcRwLock<TcpStream> - The TCP stream to read from.
• usize - The buffer size for reading.
• &mut Request - The request template to populate.

Returns

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

pub async fn ws_from_reader( reader: &mut BufReader<&mut TcpStream>, buffer: usize, request: &mut Self, ) -> RequestReaderHandleResult

Parses a WebSocket request from a buffered TCP stream.

Handles WebSocket frames including text, binary, ping, pong and close frames. Assembles the request body from frame payload data.

Arguments

• &mut BufReader<&mut TcpStream> - The buffered TCP stream reader.
• usize - The buffer size for reading frames.
• &mut Request - The request template to populate.

Returns

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

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

where K: Into<RequestQuerysKey>,

Gets a query parameter value by key.

The key type must implement Into conversion.

Arguments

• K - The query parameter key (implements Into).

Returns

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

pub fn try_get_header<K>(&self, key: K) -> OptionRequestHeadersValue

where K: Into<RequestHeadersKey>,

Retrieves the value of a request header by its key.

Arguments

• K - The header’s key (must implement Into).

Returns

• OptionRequestHeadersValue - The optional header values.

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

where K: Into<RequestHeadersKey>,

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

Arguments

• K - The header’s key (must implement Into).

Returns

• OptionRequestHeadersValueItem - The first header value if exists.

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

where K: Into<RequestHeadersKey>,

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

Arguments

• K - The header’s key (must implement Into).

Returns

• OptionRequestHeadersValueItem - The last header value if exists.

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

where K: Into<RequestHeadersKey>,

Retrieves the number of values for a specific header.

Arguments

• K - The header’s key (must implement Into).

Returns

• usize - The count of values for the header.

pub fn get_headers_values_length(&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_length(&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: Into<RequestHeadersKey>,

Checks if a specific header exists.

Arguments

• K - The header key to check (must implement Into).

Returns

• bool - Whether the header exists.

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

where K: Into<RequestHeadersKey>, V: Into<RequestHeadersValueItem>,

Checks if a header contains a specific value.

Arguments

• K - The header key to check (must implement Into).
• V - The value to search for (must implement Into).

Returns

• bool - Whether the header contains the value.

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() into 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 get_body_json<T>(&self) -> ResultJsonError<T>

where T: DeserializeOwned,

Deserializes the body content of the request into 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 into the specified type T using json_from_slice.

Type Parameters

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

Returns

• ResultJsonError<T> - The deserialization result.

pub fn get_string(&self) -> String

Converts the request to a formatted string representation.

This method provides a human-readable summary of the request, including its method, host, version, path, query parameters, headers, and body information.

Returns

• String - The formatted request details.

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 into 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 is_ws(&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(&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(&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(&self) -> bool

Checks whether the upgrade type is unknown.

Returns

• bool - Whether the upgrade type is unknown.

pub fn is_http1_1_or_higher(&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_http0_9(&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(&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(&self) -> bool

Checks whether the HTTP version is HTTP/1.1.

Returns

• bool - Whether the version is HTTP/1.1.

pub fn is_http2(&self) -> bool

Checks whether the HTTP version is HTTP/2.

Returns

• bool - Whether the version is HTTP/2.

pub fn is_http3(&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(&self) -> bool

Checks whether the version belongs to the HTTP family.

Returns

• bool - Whether the version is HTTP.

pub fn is_get(&self) -> bool

Checks whether the request method is GET.

Returns

• bool - Whether the method is GET.

pub fn is_post(&self) -> bool

Checks whether the request method is POST.

Returns

• bool - Whether the method is POST.

pub fn is_put(&self) -> bool

Checks whether the request method is PUT.

Returns

• bool - Whether the method is PUT.

pub fn is_delete(&self) -> bool

Checks whether the request method is DELETE.

Returns

• bool - Whether the method is DELETE.

pub fn is_patch(&self) -> bool

Checks whether the request method is PATCH.

Returns

• bool - Whether the method is PATCH.

pub fn is_head(&self) -> bool

Checks whether the request method is HEAD.

Returns

• bool - Whether the method is HEAD.

pub fn is_options(&self) -> bool

Checks whether the request method is OPTIONS.

Returns

• bool - Whether the method is OPTIONS.

pub fn is_connect(&self) -> bool

Checks whether the request method is CONNECT.

Returns

• bool - Whether the method is CONNECT.

pub fn is_trace(&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_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) -> &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 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 Eq for Request

impl StructuralPartialEq for Request