Struct Response

Source

pub struct Response { /* private fields */ }

Expand description

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§

Source §

impl Response

Source

pub fn new() -> Response

Creates a new instance of Response.

§Returns

An initialized Response with default values.

Source

pub fn get_header<K>(&self, key: K) -> Option<String>
where K: Into<String>,

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.

Source

pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Response
where K: Into<String>, V: Into<String>,

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.

Source

pub fn set_body<T>(&mut self, body: T) -> &mut Response
where T: Into<Vec<u8>>,

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.

Source

pub fn set_reason_phrase<T>(&mut self, reason_phrase: T) -> &mut Response
where T: Into<String>,

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.

Source

pub async fn send_body( &mut self, stream_lock: &ArcRwLockStream, is_websocket: bool, ) -> Result<(), Error>

Sends the HTTP 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.

Source

pub async fn send(&mut self, stream_lock: &ArcRwLockStream) -> Result<(), Error>

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.

Source

pub async fn flush( &mut self, stream_lock: &ArcRwLockStream, ) -> Result<(), Error>

Flush the TCP stream.

stream_lock: A reference to an ArcRwLockStream that manages the TCP stream.
Returns: A ResponseResult indicating success or failure.

Source

pub async fn close( &mut self, stream_lock: &ArcRwLockStream, ) -> Result<(), Error>

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.