Struct actix_http::Response

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

An HTTP response.

Implementations

impl Response<BoxBody>

pub fn new(status: StatusCode) -> Self

Constructs a new response with default body.

pub fn build(status: StatusCode) -> ResponseBuilder

Constructs a new response builder.

pub fn ok() -> Self

Constructs a new response with status 200 OK.

pub fn bad_request() -> Self

Constructs a new response with status 400 Bad Request.

pub fn not_found() -> Self

Constructs a new response with status 404 Not Found.

pub fn internal_server_error() -> Self

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

Formats the value using the given formatter.

impl<B: Default> Default for Response<B>

fn default() -> Response<B>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl From<&HandshakeError> for Response<BoxBody>

Available on crate feature ws only.

fn from(err: &HandshakeError) -> Self

Converts to this type from the input type.

impl From<&String> for Response<String>

fn from(val: &String) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<ByteString> for Response<ByteString>

fn from(val: ByteString) -> Self

Converts to this type from the input type.

impl From<Bytes> for Response<Bytes>

fn from(val: Bytes) -> Self

Converts to this type from the input type.

impl From<BytesMut> for Response<BytesMut>

fn from(val: BytesMut) -> Self

Converts to this type from the input type.

impl From<Error> for Response<BoxBody>

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<HandshakeError> for Response<BoxBody>

Available on crate feature ws only.

fn from(err: HandshakeError) -> Self

Converts to this type from the input type.

impl From<Infallible> for Response<BoxBody>

fn from(val: Infallible) -> Self

Converts to this type from the input type.

impl From<ParseError> for Response<BoxBody>

fn from(err: ParseError) -> Self

Converts to this type from the input type.

impl<B> From<Response<B>> for ResponseBuilder

Convert Response to a ResponseBuilder. Body get dropped.

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

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) -> Self

Converts to this type from the input type.

impl<I: Into<Response<BoxBody>>, E: Into<Error>> From<Result<I, E>> for Response<BoxBody>

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

Converts to this type from the input type.

impl From<String> for Response<String>

fn from(val: String) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.