Struct actix_web::CustomizeResponder

source ·
pub struct CustomizeResponder<R> { /* private fields */ }
Expand description

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

Created by calling the customize method on a Responder type.

Implementations§

source§

impl<R: Responder> CustomizeResponder<R>

source

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);
source

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");
source

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");
Available on crate feature cookies only.

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,

§

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

source§

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

Convert self to HttpResponse.
source§

fn customize(self) -> CustomizeResponder<Self>
where Self: Sized,

Wraps responder to allow alteration of its response. Read more

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> 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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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