Struct Response

pub struct Response { /* private fields */ }

HTTP response builder with a fluent API for creating responses.

The Response struct provides a convenient, chainable interface for building HTTP responses. It supports setting status codes, headers, and body content with type-safe methods and automatic content-type detection.

Examples

Basic Responses

use torch_web::Response;

// Simple text response
let response = Response::ok().body("Hello, World!");

// JSON response
let data = serde_json::json!({"message": "Hello", "status": "success"});
let response = Response::ok().json(&data);

// Custom status code
let response = Response::with_status(StatusCode::CREATED)
    .body("Resource created");

With Headers

use torch_web::Response;

let response = Response::ok()
    .header("Content-Type", "application/json")
    .header("X-API-Version", "1.0")
    .header("Cache-Control", "no-cache")
    .body(r#"{"data": "value"}"#);

Error Responses

use torch_web::Response;

// 404 Not Found
let response = Response::not_found();

// 400 Bad Request with custom message
let response = Response::bad_request()
    .body("Invalid request parameters");

// 500 Internal Server Error
let response = Response::internal_error()
    .body("Something went wrong");

Redirects

use torch_web::Response;

// Temporary redirect
let response = Response::redirect_temporary("/new-location");

// Permanent redirect
let response = Response::redirect_permanent("/moved-permanently");

File Downloads

use torch_web::Response;

let file_data = std::fs::read("document.pdf")?;
let response = Response::ok()
    .header("Content-Type", "application/pdf")
    .header("Content-Disposition", "attachment; filename=\"document.pdf\"")
    .body(file_data);

Implementations

impl Response

pub fn new() -> Self

Create a new response with 200 OK status

pub fn ok() -> Self

Create a response with 200 OK status (alias for new)

pub fn with_status(status: StatusCode) -> Self

Create a response with a specific status code

pub fn not_found() -> Self

Create a 404 Not Found response

pub fn internal_error() -> Self

Create a 500 Internal Server Error response

pub fn bad_request() -> Self

Create a 400 Bad Request response

pub fn created() -> Self

Create a 201 Created response

pub fn no_content() -> Self

Create a 204 No Content response

pub fn unauthorized() -> Self

Create a 401 Unauthorized response

pub fn forbidden() -> Self

Create a 403 Forbidden response

pub fn unprocessable_entity() -> Self

Create a 422 Unprocessable Entity response

pub fn too_many_requests() -> Self

Create a 429 Too Many Requests response

pub fn status(self, status: StatusCode) -> Self

Set the status code

pub fn body<T: Into<Vec<u8>>>(self, body: T) -> Self

Set the response body from a string

pub fn body_from_bytes(self, body: Vec<u8>) -> Self

Set the response body from bytes

pub fn header<K, V>(self, key: K, value: V) -> Self

where K: TryInto<HeaderName>, V: TryInto<HeaderValue>, K::Error: Debug, V::Error: Debug,

Set a header

pub fn content_type(self, content_type: &str) -> Self

Set the Content-Type header

pub fn json<T: Serialize>(self, value: &T) -> Result<Self, Error>

Set response as JSON and serialize the value (requires “json” feature)

pub fn html<T: Into<Vec<u8>>>(self, html: T) -> Self

Set response as HTML

pub fn text<T: Into<Vec<u8>>>(self, text: T) -> Self

Set response as plain text

pub fn redirect(status: StatusCode, location: &str) -> Self

Redirect to another URL

pub fn redirect_found(location: &str) -> Self

Redirect with 302 Found status

pub fn redirect_permanent(location: &str) -> Self

Redirect with 301 Moved Permanently status

pub fn status_code(&self) -> StatusCode

Get the status code

pub fn status_code_mut(&mut self) -> &mut StatusCode

Get a mutable reference to the status code

pub fn headers(&self) -> &HeaderMap

Get the headers

pub fn body_data(&self) -> &[u8]

Get the body as bytes

pub fn body_bytes(&self) -> &[u8]

Get the body as bytes (alias for body_data)

pub fn into_hyper_response(self) -> Response<Full<Bytes>>

Convert to hyper Response

Trait Implementations

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 From<&str> for Response

fn from(body: &str) -> Self

Converts to this type from the input type.

impl From<StatusCode> for Response

fn from(status: StatusCode) -> Self

Converts to this type from the input type.

impl From<String> for Response

fn from(body: String) -> Self

Converts to this type from the input type.

impl IntoResponse for Response

fn into_response(self) -> Response