Struct HttpResponse 

pub struct HttpResponse {
    pub status: StatusCode,
    pub body: Bytes,
    pub max_age: Option<u32>,
    pub created_at: Option<u32>,
    pub cache_private: Option<bool>,
    pub headers: Option<Vec<HttpHeader>>,
}

Represents a complete HTTP response, including status, headers, and a body. This struct is used for responses where the entire body is known upfront.

Fields

status: StatusCode

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

body: Bytes

The response body, stored as a Bytes object for efficiency.

max_age: Option<u32>

The max-age directive for the Cache-Control header, in seconds.

created_at: Option<u32>

The UNIX timestamp when the response content was created, used for the Age header.

cache_private: Option<bool>

A flag to indicate if the Cache-Control should be “private” (true) or “public” (false).

headers: Option<Vec<HttpHeader>>

A list of additional HTTP headers to include in the response.

Implementations

impl HttpResponse

pub fn builder(status: StatusCode) -> HttpResponseBuilder

Returns a new HttpResponseBuilder to start building a response.

pub fn no_content() -> Self

A convenience constructor for a 204 No Content response.

pub fn bad_request(body: impl Into<Bytes>) -> Self

A convenience constructor for a 400 Bad Request response.

pub fn not_found(body: impl Into<Bytes>) -> Self

A convenience constructor for a 404 Not Found response.

pub fn unknown_error(body: impl Into<Bytes>) -> Self

A convenience constructor for a 500 Internal Server Error response.

pub fn html(body: impl Into<Bytes>) -> Self

A convenience constructor for a 200 OK HTML response.

pub fn redirect(location: &str) -> Result<Self>

A convenience constructor for a 302 Temporary Redirect response.

pub fn text(body: impl Into<Bytes>) -> Self

A convenience constructor for a 200 OK plain text response.

pub fn try_from_json<T>(value: &T) -> Result<Self>

where T: ?Sized + Serialize,

Creates a 200 OK JSON response by serializing the given value.

pub fn try_from_json_status<T>(value: &T, status: StatusCode) -> Result<Self>

where T: ?Sized + Serialize,

Creates a JSON response with a specified status code by serializing the given value.

pub fn new_response_header(&self) -> Result<ResponseHeader>

Builds a pingora::http::ResponseHeader from the HttpResponse’s properties.

pub async fn send(self, session: &mut Session) -> Result<usize>

Sends the entire HTTP response (header and body) to the client via the session.

Trait Implementations

impl Clone for HttpResponse

fn clone(&self) -> HttpResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpResponse

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

Formats the value using the given formatter.

impl Default for HttpResponse

fn default() -> HttpResponse

Returns the “default value” for a type.