Struct Response

pub struct Response { /* private fields */ }

Represents an HTTP response.

Fields

• version: The HTTP version of the response.
• status_code: The status code of the response.
• reason_phrase: The reason phrase corresponding to the status code.
• headers: A collection of HTTP headers as key-value pairs.
• body: The binary body of the response.

Implementations

impl Response

pub fn new() -> Self

Creates a new instance of Response.

Returns

• An initialized Response with default values.

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

where K: Into<ResponseHeadersKey>,

Retrieves the value of a response header by its key.

Parameters

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

Returns

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

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) -> ResultSerdeJsonError<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 serde_json::from_str.

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(serde_json::Error): An error if the deserialization fails (e.g., invalid JSON format or type mismatch).

pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<ResponseHeadersKey>, V: Into<ResponseHeadersValue>,

Adds a header to the response.

This function inserts a key-value pair into the response headers. The key and value are converted into ResponseHeadersKey, allowing for efficient handling of both owned and borrowed string data.

Parameters

• key: The header key, which will be converted into a ResponseHeadersKey.
• value: The value of the header, which will be converted into a ResponseHeadersValue.

Returns

• Returns a mutable reference to the current instance (&mut Self), allowing for method chaining.

pub fn set_body<T: Into<ResponseBody>>(&mut self, body: T) -> &mut Self

Set the body of the response.

This method allows you to set the body of the response by converting the provided value into a ResponseBody type. The body is updated with the converted value, and the method returns a mutable reference to the current instance for method chaining.

Parameters

• body: The body of the response to be set. It can be any type that can be converted into a ResponseBody using the Into trait.

Return Value

• Returns a mutable reference to the current instance of the struct, enabling method chaining. Set the body of the response.

This method allows you to set the body of the response by converting the provided value into a ResponseBody type. The body is updated with the converted value, and the method returns a mutable reference to the current instance for method chaining.

Parameters

• body: The body of the response to be set. It can be any type that can be converted into a ResponseBody using the Into trait.

Return Value

• Returns a mutable reference to the current instance of the struct, enabling method chaining.

pub fn set_reason_phrase<T: Into<ResponseReasonPhrase>>( &mut self, reason_phrase: T, ) -> &mut Self

Set the reason phrase of the response.

This method allows you to set the reason phrase of the response by converting the provided value into a ResponseReasonPhrase type. The reason_phrase is updated with the converted value, and the method returns a mutable reference to the current instance for method chaining.

Parameters

• reason_phrase: The reason phrase to be set for the response. It can be any type that can be converted into a ResponseReasonPhrase using the Into trait.

Return Value

• Returns a mutable reference to the current instance of the struct, enabling method chaining.

pub async fn send_body_with_websocket_flag( &mut self, stream_lock: &ArcRwLockStream, is_websocket: bool, ) -> ResponseResult

Sends the HTTP or HTTP websocket response body over a TCP stream.

Parameters

• stream: A mutable reference to the TcpStream to send the response.
• is_websocket: Is websocket

Returns

• Ok: If the response body is successfully sent.
• Err: If an error occurs during sending.

pub async fn send_body( &mut self, stream_lock: &ArcRwLockStream, ) -> ResponseResult

Sends the HTTP response body over a TCP stream.

Parameters

• stream: A mutable reference to the TcpStream to send the response.

Returns

• Ok: If the response body is successfully sent.
• Err: If an error occurs during sending.

pub async fn send_websocket_body( &mut self, stream_lock: &ArcRwLockStream, ) -> ResponseResult

Sends the HTTP websocket response body over a TCP stream.

Parameters

• stream: A mutable reference to the TcpStream to send the response.

Returns

• Ok: If the response body is successfully sent.
• Err: If an error occurs during sending.

pub async fn send(&mut self, stream_lock: &ArcRwLockStream) -> ResponseResult

Sends the HTTP response over a TCP stream.

Parameters

• stream: A mutable reference to the TcpStream to send the response.

Returns

• Ok: If the response is successfully sent.
• Err: If an error occurs during sending.

pub async fn flush(&mut self, stream_lock: &ArcRwLockStream) -> ResponseResult

Flush the TCP stream.

• stream_lock: A reference to an ArcRwLockStream that manages the TCP stream.

• Returns: A ResponseResult indicating success or failure.

pub async fn close(&mut self, stream_lock: &ArcRwLockStream) -> ResponseResult

Closes the stream after sending the response.

This function is responsible for:

• Building the response using the build() method.
• Setting the response using the set_response() method.
• Shutting down the write half of the TCP stream to indicate no more data will be sent.

Parameters

• stream: A reference to the TcpStream that will be closed after sending the response.

Returns

• ResponseResult: The result of the operation, indicating whether the closure was successful or if an error occurred.

pub fn get_string(&self) -> String

Converts the response to a formatted string representation.

• Returns: A String containing formatted response details.

impl Response

pub fn get_version(&self) -> &ResponseVersion

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

pub fn get_status_code(&self) -> &ResponseStatusCode

pub fn get_mut_status_code(&mut self) -> &mut ResponseStatusCode

pub fn set_status_code(&mut self, val: ResponseStatusCode) -> &mut Self

pub fn get_reason_phrase(&self) -> &ResponseReasonPhrase

pub fn get_mut_reason_phrase(&mut self) -> &mut ResponseReasonPhrase

pub fn get_headers(&self) -> &ResponseHeaders

pub fn get_mut_headers(&mut self) -> &mut ResponseHeaders

pub fn set_headers(&mut self, val: ResponseHeaders) -> &mut Self

pub fn get_body(&self) -> &ResponseBody

pub fn get_mut_body(&mut self) -> &mut ResponseBody

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

Returns the “default value” for a type.

impl Display for Response

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

Formats the value using the given formatter.