Skip to main content

Response

Struct Response 

Source
pub struct Response {
    pub status_code: u16,
    pub status_text: String,
    pub headers: Vec<(String, String)>,
    pub body: Vec<u8>,
}
Expand description

Represents an HTTP response payload and metadata.

You create this type on the response path, add headers, and serialize it to any Write sink (for example TcpStream or an in-memory buffer in tests).

§Examples

use http_handle::response::Response;

let response = Response::new(200, "OK", b"hello".to_vec());
assert_eq!(response.status_code, 200);

§Panics

This type does not panic on construction.

Fields§

§status_code: u16

The HTTP status code (e.g., 200 for OK, 404 for Not Found).

§status_text: String

The HTTP status text associated with the status code (e.g., “OK”, “Not Found”).

§headers: Vec<(String, String)>

A list of headers in the response, each represented as a tuple containing the header name and its corresponding value.

§body: Vec<u8>

The body of the response, represented as a vector of bytes.

Implementations§

Source§

impl Response

Source

pub fn new(status_code: u16, status_text: &str, body: Vec<u8>) -> Self

Creates a response with status, reason, and body bytes.

The headers are initialized as an empty list and can be added later using the add_header method.

§Arguments
  • status_code - The HTTP status code for the response.
  • status_text - The status text corresponding to the status code.
  • body - The body of the response, represented as a vector of bytes.
§Examples
use http_handle::response::Response;

let response = Response::new(204, "NO CONTENT", Vec::new());
assert_eq!(response.status_code, 204);
§Panics

This function does not panic.

Source

pub fn add_header(&mut self, name: &str, value: &str)

Adds a header to the response.

This method allows you to add custom headers to the response, which will be included in the HTTP response when it is sent to the client.

§Examples
use http_handle::response::Response;

let mut response = Response::new(200, "OK", Vec::new());
response.add_header("Content-Type", "text/plain");
assert_eq!(response.headers.len(), 1);
§Panics

This function does not panic.

Source

pub fn send<W: Write>(&self, stream: &mut W) -> Result<(), ServerError>

Sends the response over the provided Write stream.

This method writes the HTTP status line, headers, and body to the stream, ensuring the client receives the complete response.

§Arguments
  • stream - A mutable reference to any stream that implements Write.
§Examples
use http_handle::response::Response;
use std::io::Cursor;

let mut response = Response::new(200, "OK", b"hello".to_vec());
response.add_header("Content-Type", "text/plain");

let mut out = Cursor::new(Vec::<u8>::new());
response.send(&mut out).expect("response write should succeed");
assert!(!out.get_ref().is_empty());
§Errors

Returns Err when writing headers or body to the output stream fails.

§Panics

This function does not intentionally panic.

Trait Implementations§

Source§

impl Clone for Response

Source§

fn clone(&self) -> Response

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Response

Source§

fn default() -> Response

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Response

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for Response

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Response

Source§

fn eq(&self, other: &Response) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Response

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Response

Source§

impl StructuralPartialEq for Response

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,