Struct Response

Source

pub struct Response { /* private fields */ }

Expand description

Represents an HTTP response.

§Fields

version: The HTTP version of the response (e.g., HTTP/1.1).
status_code: The status code of the response (e.g., 200, 404).
reason_phrase: The reason phrase corresponding to the status code (e.g., OK, Not Found).
headers: A collection of HTTP headers as key-value pairs.
body: The binary body of the response.
response: The serialized HTTP response including headers and body.

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 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 String, allowing for efficient handling of both owned and borrowed string data.

§Parameters

key: The header key, which will be converted into a String.
value: The value of the header, which will be converted into a String.

§Returns

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

Source

pub fn build(&mut self) -> Vec<u8> ⓘ

Builds the full HTTP response as a byte vector.

§Returns

The serialized HTTP response including headers and body.

Source

pub fn send_body(&mut self, stream: &TcpStream) -> Result<(), Error>

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.

Source

pub fn close(&mut self, stream: &TcpStream) -> 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.

§Parameters

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

§Returns

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

Source

pub fn send(&mut self, stream: &TcpStream) -> 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 async_send_body( &mut self, stream: &mut TcpStream, ) -> Result<(), Error>

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.

Source

pub fn async_close(&mut self, stream: &mut TcpStream) -> 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.