Struct Response

pub struct Response<B> { /* private fields */ }

An HTTP response.

Implementations

impl Response<BoxBody>

pub fn new(status: StatusCode) -> Response<BoxBody>

Constructs a new response with default body.

pub fn build(status: StatusCode) -> ResponseBuilder

Constructs a new response builder.

pub fn ok() -> Response<BoxBody>

Constructs a new response with status 200 OK.

pub fn bad_request() -> Response<BoxBody>

Constructs a new response with status 400 Bad Request.

pub fn not_found() -> Response<BoxBody>

Constructs a new response with status 404 Not Found.

pub fn internal_server_error() -> Response<BoxBody>

Constructs a new response with status 500 Internal Server Error.

impl<B> Response<B>

pub fn with_body(status: StatusCode, body: B) -> Response<B>

Constructs a new response with given body.

pub fn head(&self) -> &ResponseHead

Returns a reference to the head of this response.

pub fn head_mut(&mut self) -> &mut ResponseHead

Returns a mutable reference to the head of this response.

pub fn status(&self) -> StatusCode

Returns the status code of this response.

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

Returns a mutable reference the status code of this response.

pub fn headers(&self) -> &HeaderMap

Returns a reference to response headers.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns a mutable reference to response headers.

pub fn upgrade(&self) -> bool

Returns true if connection upgrade is enabled.

pub fn keep_alive(&self) -> bool

Returns true if keep-alive is enabled.

pub fn extensions(&self) -> Ref<'_, Extensions>

Returns a reference to the request-local data/extensions container.

pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>

Returns a mutable reference to the request-local data/extensions container.

pub fn body(&self) -> &B

Returns a reference to the body of this response.

pub fn set_body<B2>(self, body: B2) -> Response<B2>

Sets new body.

pub fn drop_body(self) -> Response<()>

Drops body and returns new response.

pub fn into_parts(self) -> (Response<()>, B)

Returns split head and body.

Implementation Notes

Due to internal performance optimizations, the first element of the returned tuple is a Response as well but only contains the head of the response this was called on.

pub fn map_body<F, B2>(self, f: F) -> Response<B2>

where F: FnOnce(&mut ResponseHead, B) -> B2,

Map the current body type to another using a closure, returning a new response.

Closure receives the response head and the current body type.

pub fn map_into_boxed_body(self) -> Response<BoxBody>

where B: MessageBody + 'static,

Map the current body to a type-erased BoxBody.

pub fn into_body(self) -> B

Returns the response body, dropping all other parts.

Trait Implementations

impl<B> Debug for Response<B>

where B: MessageBody,

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

Formats the value using the given formatter.

impl<B> Default for Response<B>

where B: Default,

fn default() -> Response<B>

Returns the “default value” for a type.

impl From<&'static [u8]> for Response<&'static [u8]>

fn from(val: &'static [u8]) -> Response<&'static [u8]>

Converts to this type from the input type.

impl From<&HandshakeError> for Response<BoxBody>

fn from(err: &HandshakeError) -> Response<BoxBody>

Converts to this type from the input type.

impl From<&String> for Response<String>

fn from(val: &String) -> Response<String>

Converts to this type from the input type.

impl From<&Vec<u8>> for Response<Vec<u8>>

fn from(val: &Vec<u8>) -> Response<Vec<u8>>

Converts to this type from the input type.

impl From<&'static str> for Response<&'static str>

fn from(val: &'static str) -> Response<&'static str>

Converts to this type from the input type.

impl From<ByteString> for Response<ByteString>

fn from(val: ByteString) -> Response<ByteString>

Converts to this type from the input type.

impl From<Bytes> for Response<Bytes>

fn from(val: Bytes) -> Response<Bytes>

Converts to this type from the input type.

impl From<BytesMut> for Response<BytesMut>

fn from(val: BytesMut) -> Response<BytesMut>

Converts to this type from the input type.

impl<E, U, I> From<DispatcherError<E, U, I>> for Response<BoxBody>

where E: Debug + Display, U: Encoder<I> + Decoder, <U as Encoder<I>>::Error: Debug, <U as Decoder>::Error: Debug,

fn from(err: DispatcherError<E, U, I>) -> Response<BoxBody>

Converts to this type from the input type.

impl From<Error> for Response<BoxBody>

fn from(err: Error) -> Response<BoxBody>

Converts to this type from the input type.

impl From<Error> for Response<BoxBody>

fn from(err: Error) -> Response<BoxBody>

Converts to this type from the input type.

impl From<HandshakeError> for Response<BoxBody>

fn from(err: HandshakeError) -> Response<BoxBody>

Converts to this type from the input type.

impl<B> From<HttpResponse<B>> for Response<B>

fn from(res: HttpResponse<B>) -> Self

Converts to this type from the input type.

impl From<HttpResponseBuilder> for Response<BoxBody>

fn from(builder: HttpResponseBuilder) -> Self

Converts to this type from the input type.

impl From<Infallible> for Response<BoxBody>

fn from(val: Infallible) -> Response<BoxBody>

Converts to this type from the input type.

impl From<ParseError> for Response<BoxBody>

fn from(err: ParseError) -> Response<BoxBody>

Converts to this type from the input type.

impl<B> From<Response<B>> for HttpResponse<B>

fn from(res: Response<B>) -> Self

Converts to this type from the input type.

impl From<Response<BoxBody>> for DispatchError

fn from(original: Response<BoxBody>) -> DispatchError

Converts to this type from the input type.

impl From<ResponseBuilder> for Response<EitherBody<()>>

fn from(builder: ResponseBuilder) -> Response<EitherBody<()>>

Converts to this type from the input type.

impl<I, E> From<Result<I, E>> for Response<BoxBody>

where I: Into<Response<BoxBody>>, E: Into<Error>,

fn from(res: Result<I, E>) -> Response<BoxBody>

Converts to this type from the input type.

impl<B> From<ServiceResponse<B>> for Response<B>

fn from(res: ServiceResponse<B>) -> Response<B>

Converts to this type from the input type.

impl From<String> for Response<String>

fn from(val: String) -> Response<String>

Converts to this type from the input type.

impl From<Vec<u8>> for Response<Vec<u8>>

fn from(val: Vec<u8>) -> Response<Vec<u8>>

Converts to this type from the input type.

impl Responder for Response<BoxBody>

type Body = BoxBody

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

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.