Struct actix_web::CustomizeResponder

pub struct CustomizeResponder<R> { /* private fields */ }

Allows overriding status code and headers (including cookies) for a Responder.

Created by calling the customize method on a Responder type.

Implementations

impl<R: Responder> CustomizeResponder<R>

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

Override a status code for the Responder’s response.

Examples

use actix_web::{Responder, http::StatusCode, test::TestRequest};

let responder = "Welcome!".customize().with_status(StatusCode::ACCEPTED);

let request = TestRequest::default().to_http_request();
let response = responder.respond_to(&request);
assert_eq!(response.status(), StatusCode::ACCEPTED);

pub fn insert_header(self, header: impl TryIntoHeaderPair) -> Self

Insert (override) header in the final response.

Overrides other headers with the same name. See HeaderMap::insert.

Headers added with this method will be inserted before those added with append_header. As such, header(s) can be overridden with more than one new header by first calling insert_header followed by append_header.

Examples

use actix_web::{Responder, test::TestRequest};

let responder = "Hello world!"
    .customize()
    .insert_header(("x-version", "1.2.3"));

let request = TestRequest::default().to_http_request();
let response = responder.respond_to(&request);
assert_eq!(response.headers().get("x-version").unwrap(), "1.2.3");

pub fn append_header(self, header: impl TryIntoHeaderPair) -> Self

Append header to the final response.

Unlike insert_header, this will not override existing headers. See HeaderMap::append.

Headers added here are appended after additions/overrides from insert_header.

Examples

use actix_web::{Responder, test::TestRequest};

let responder = "Hello world!"
    .customize()
    .append_header(("x-version", "1.2.3"));

let request = TestRequest::default().to_http_request();
let response = responder.respond_to(&request);
assert_eq!(response.headers().get("x-version").unwrap(), "1.2.3");

pub fn add_cookie(self, cookie: &Cookie<'_>) -> Self

Appends a cookie to the final response.

Errors

Final response will be an error if cookie cannot be converted into a valid header value.

Trait Implementations

impl<T> Responder for CustomizeResponder<T>

where T: Responder,

type Body = EitherBody<<T as Responder>::Body>

fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.