Struct Response

Source

pub struct Response { /* private fields */ }

Expand description

Represents a parsed HTTP response.

Implementations§

Source §

impl Response

Source

pub fn new() -> Self

Creates a new instance of Response.

§Returns

Response - A new response instance with default values.

Source

pub fn try_get_header<K>(&self, key: K) -> OptionResponseHeadersValue
where K: Into<ResponseHeadersKey>,

Retrieves the value of a response header by its key.

§Arguments

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

§Returns

OptionResponseHeadersValue - The optional header values.

Source

pub fn try_get_header_front<K>(&self, key: K) -> OptionResponseHeadersValueItem
where K: Into<ResponseHeadersKey>,

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

§Arguments

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

§Returns

OptionResponseHeadersValueItem - The first header value if exists.

Source

pub fn try_get_header_back<K>(&self, key: K) -> OptionResponseHeadersValueItem
where K: Into<ResponseHeadersKey>,

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

§Arguments

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

§Returns

OptionResponseHeadersValueItem - The last header value if exists.

Source

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

Checks if a header exists in the response.

§Arguments

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

§Returns

bool - Whether the header exists.

Source

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

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.

Source

pub fn get_headers_length(&self) -> usize

Gets the number of headers in the response.

§Returns

usize - The count of unique header keys.

Source

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

Gets the number of values for a specific header key.

§Arguments

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

§Returns

usize - The count of values for the header.

Source

pub fn get_headers_values_length(&self) -> usize

Gets the total number of header values in the response.

This counts all values across all headers, so a header with multiple values will contribute more than one to the total count.

§Returns

usize - The total count of all header values.

Source

pub fn get_body_string(&self) -> String

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

Source

pub fn get_body_json<T>(&self) -> ResultJsonError<T>
where T: DeserializeOwned,

Deserializes the body content of the response 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.

Source

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

Sets a header in the response, replacing any existing values.

This function replaces all existing values for a header with a single new value.

§Arguments

K - The header key (must implement Into).
V - The header value (must implement Into).

§Returns

&mut Self - A mutable reference to self for chaining.

Source

pub fn add_header<K, V>(&mut self, key: K, value: V) -> &mut Self
where K: Into<ResponseHeadersKey>, V: Into<String>,

Adds a header to the response.

This function appends a value to the response headers. If the header already exists, the new value will be added to the existing values.

§Arguments

K - The header key (must implement Into).
V - The header value (must implement Into).

§Returns

&mut Self - A mutable reference to self for chaining.

Source

pub fn remove_header<K>(&mut self, key: K) -> &mut Self
where K: Into<ResponseHeadersKey>,

Removes a header from the response.

This function removes all values for the specified header key.

§Arguments

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

§Returns

&mut Self - A mutable reference to self for chaining.

Source

pub fn remove_header_value<K, V>(&mut self, key: K, value: V) -> &mut Self
where K: Into<ResponseHeadersKey>, V: Into<String>,

Removes a specific value from a header in the response.

This function removes only the specified value from the header. If the header has multiple values, only the matching value is removed. If this was the last value for the header, the entire header is removed.

§Arguments

K - The header key (must implement Into).
V - The value to remove (must implement Into).

§Returns

&mut Self - A mutable reference to self for chaining.

Source

pub fn clear_headers(&mut self) -> &mut Self

Clears all headers from the response.

This function removes all headers, leaving the headers map empty.

§Returns

&mut Self - A mutable reference to self for chaining.

Source

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

Sets 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.

§Arguments

T - The body content (must implement Into).

§Returns

&mut Self - A mutable reference to self for chaining.

Source

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

Sets 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.

§Arguments

T - The reason phrase (must implement Into).

§Returns

&mut Self - A mutable reference to self for chaining.

Source

pub fn build(&mut self) -> ResponseData

Builds the full HTTP response as a byte vector.

This method constructs the complete HTTP response, including the status line, headers, and body. It handles content encoding, content type, connection management, and content length.