Struct Request

pub struct Request { /* private fields */ }

Represents a parsed HTTP request.

Implementations

impl Request

pub fn new() -> Self

Creates a new instance of Request.

Returns

• An initialized Request with default values.

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

Creates a new Request object from a TCP stream.

Parameters

• reader: A mut reference to a &mut BufReader<&mut TcpStream>.
• buffer_size: Request buffer size.

Returns

• Ok: A Request object populated with the HTTP request data.
• Err: An RequestError if the request is invalid or cannot be read.

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

Creates a new Request object from a TCP stream.

Parameters

• stream: A reference to a &ArcRwLockStream representing the incoming connection.
• buffer_size: Request buffer size.

Returns

• Ok: A Request object populated with the HTTP request data.
• Err: An RequestError if the request is invalid or cannot be read.

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

Creates a new Request object from a TCP stream.

Parameters

• stream: A reference to a &ArcRwLockStream representing the incoming connection.
• buffer_size: Request buffer size.
• request: A reference to a Request object. This object is used as a template.

Returns

• Ok: A Request object populated with the HTTP request data.
• Err: An RequestError if the request is invalid or cannot be read.

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

Reads a WebSocket request from a TCP stream and constructs a Request object.

This function reads data from the provided BufReader wrapped around a TcpStream. It attempts to read up to 1024 bytes into a buffer and constructs a Request object based on the received data. The request body is set using the received bytes.

Arguments

• reader - A mutable reference to a BufReader wrapping a TcpStream. This reader is used to read the incoming WebSocket request data.
• buffer_size: - Request buffer size.
• request - A reference to a Request object. This object is used as a template.

Returns

• Ok(Request) - A Request object constructed from the received data.
  • If no data is read (Ok(0)), an empty Request object is returned.
  • If data is successfully read, the request body is set with the received bytes.
• Err(RequestError::InvalidWebSocketRequest) - If an error occurs while reading from the stream.

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

where K: Into<RequestQuerysKey>,

Retrieves the value of a query parameter by its key.

Parameters

• key: The query parameter’s key, which can be of any type that implements Into<RequestQuerysKey>.

Returns

• OptionRequestQuerysValue: Returns Some(value) if the key exists in the query parameters, or None if the key does not exist.

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

where K: Into<RequestHeadersKey>,

Retrieves the value of a request header by its key.

Parameters

• key: The header’s key, which can be of any type that implements Into<RequestHeadersKey>.

Returns

• OptionRequestHeadersValue: Returns Some(value) if the key exists in the request headers, or None if the key does not exist.

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

where K: Into<RequestHeadersKey>,

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

Parameters

• key: The header’s key, which can be of any type that implements Into<RequestHeadersKey>.

Returns

• OptionRequestHeadersValueItem: Returns Some(value) if the key exists and has at least one value, or None if the key does not exist or has no values.

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

where K: Into<RequestHeadersKey>,

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

Parameters

• key: The header’s key, which can be of any type that implements Into<RequestHeadersKey>.

Returns

• OptionRequestHeadersValueItem: Returns Some(value) if the key exists and has at least one value, or None if the key does not exist or has no values.

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

where K: Into<RequestHeadersKey>,

Retrieves the number of values for a specific header.

Parameters

• key: The header’s key, which can be of any type that implements Into<RequestHeadersKey>.

Returns

• usize: The number of values for the specified header. Returns 0 if the header does not exist.

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 number of unique header keys.

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

where K: Into<RequestHeadersKey>,

Checks if a specific header exists.

Parameters

• key: The header key to check, which will be converted into a RequestHeadersKey.

Returns

• bool: Returns true if the header exists, false otherwise.

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.

Parameters

• key: The header key to check, which will be converted into a RequestHeadersKey.
• value: The value to search for in the header.

Returns

• bool: Returns true if the header exists and contains the specified value, false otherwise.

pub fn get_body_string(&self) -> String

Retrieves the body content of the object 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

A String containing the body content.

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

where T: DeserializeOwned,

Deserializes the body content of the object into a specified type T.

This method first retrieves the body content as a UTF-8 encoded string using self.get_body(). It then attempts to deserialize the string into the specified type T using json_from_slice.

Type Parameters

• T: The target type to deserialize into. It must implement the DeserializeOwned trait.

Returns

• Ok(T): The deserialized object of type T if the deserialization is successful.
• Err(ResultJsonError): An error if the deserialization fails.

pub fn get_string(&self) -> String

Converts the request to a formatted string representation.

• Returns: A String containing formatted request details.

pub fn get_upgrade_type(&self) -> UpgradeType

Retrieves the upgrade type from the request headers.

• Returns: The UpgradeType extracted from the UPGRADE header. If the header is missing or invalid, returns the default UpgradeType.

pub fn is_ws(&self) -> bool

Checks whether the WebSocket upgrade is enabled.

• Returns: true if the upgrade type is WebSocket; otherwise, false.

pub fn is_h2c(&self) -> bool

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

• &self - The current instance (usually a request or context struct).

• Returns true if the upgrade type is h2c, otherwise false.

pub fn is_tls(&self) -> bool

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

• &self - The current instance (usually a request or context struct).

• Returns true if the upgrade type is any Tls variant, otherwise false.

pub fn is_unknown_upgrade(&self) -> bool

Checks whether the upgrade type is unknown.

• Returns: true if the upgrade type is unknown; otherwise, false.

pub fn is_http1_1_or_higher(&self) -> bool

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

• Returns: true if the HTTP version is 1.1 or higher; otherwise, false.

pub fn is_http0_9(&self) -> bool

Checks whether the HTTP version is HTTP/0.9.

• Returns: true if the version is HTTP/0.9; otherwise, false.

pub fn is_http1_0(&self) -> bool

Checks whether the HTTP version is HTTP/1.0.

• Returns: true if the version is HTTP/1.0; otherwise, false.

pub fn is_http1_1(&self) -> bool

Checks whether the HTTP version is HTTP/1.1.

• Returns: true if the version is HTTP/1.1; otherwise, false.

pub fn is_http2(&self) -> bool

Checks whether the HTTP version is HTTP/2.

• Returns: true if the version is HTTP/2; otherwise, false.

pub fn is_http3(&self) -> bool

Checks whether the HTTP version is HTTP/3.

• Returns: true if the version is HTTP/3; otherwise, false.

pub fn is_unknown_version(&self) -> bool

Checks whether the HTTP version is unknown.

• Returns: true if the version is unknown; otherwise, false.

pub fn is_http(&self) -> bool

Checks whether the version belongs to the HTTP family.

• Returns: true if the version is a valid HTTP version; otherwise, false.

pub fn is_get(&self) -> bool

Checks whether the request method is GET.

• Returns: true if the method is GET; otherwise, false.

pub fn is_post(&self) -> bool

Checks whether the request method is POST.

• Returns: true if the method is POST; otherwise, false.

pub fn is_put(&self) -> bool

Checks whether the request method is PUT.

• Returns: true if the method is PUT; otherwise, false.

pub fn is_delete(&self) -> bool

Checks whether the request method is DELETE.

• Returns: true if the method is DELETE; otherwise, false.

pub fn is_patch(&self) -> bool

Checks whether the request method is PATCH.

• Returns: true if the method is PATCH; otherwise, false.

pub fn is_head(&self) -> bool

Checks whether the request method is HEAD.

• Returns: true if the method is HEAD; otherwise, false.

pub fn is_options(&self) -> bool

Checks whether the request method is OPTIONS.

• Returns: true if the method is OPTIONS; otherwise, false.

pub fn is_connect(&self) -> bool

Checks whether the request method is CONNECT.

• Returns: true if the method is CONNECT; otherwise, false.

pub fn is_trace(&self) -> bool

Checks whether the request method is TRACE.

• Returns: true if the method is TRACE; otherwise, false.

pub fn is_unknown_method(&self) -> bool

Checks whether the request method is UNKNOWN.

• Returns: true if the method is UNKNOWN; otherwise, false.

pub fn is_enable_keep_alive(&self) -> bool

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

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

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

Returns

• bool: true if keep-alive should be enabled, false otherwise

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

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