Struct actix_web::CustomizeResponder
source · pub struct CustomizeResponder<R> { /* private fields */ }
Expand description
Implementations§
source§impl<R: Responder> CustomizeResponder<R>
impl<R: Responder> CustomizeResponder<R>
sourcepub fn with_status(self, status: StatusCode) -> Self
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);
sourcepub fn insert_header(self, header: impl TryIntoHeaderPair) -> Self
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");
sourcepub fn append_header(self, header: impl TryIntoHeaderPair) -> Self
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");
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§
source§impl<T> Responder for CustomizeResponder<T>where
T: Responder,
impl<T> Responder for CustomizeResponder<T>where
T: Responder,
type Body = EitherBody<<T as Responder>::Body>
source§fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body>
fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body>
Convert self to
HttpResponse
.Auto Trait Implementations§
impl<R> Freeze for CustomizeResponder<R>where
R: Freeze,
impl<R> RefUnwindSafe for CustomizeResponder<R>where
R: RefUnwindSafe,
impl<R> Send for CustomizeResponder<R>where
R: Send,
impl<R> Sync for CustomizeResponder<R>where
R: Sync,
impl<R> Unpin for CustomizeResponder<R>where
R: Unpin,
impl<R> UnwindSafe for CustomizeResponder<R>where
R: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more