Struct actix_web::web::HttpResponse
source · [−]pub struct HttpResponse<B = BoxBody> { /* private fields */ }Expand description
An outgoing response.
Implementations
sourceimpl HttpResponse
impl HttpResponse
pub fn Continue() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn SwitchingProtocols() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Processing() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Ok() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Created() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Accepted() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn NonAuthoritativeInformation() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn NoContent() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn ResetContent() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn PartialContent() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn MultiStatus() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn AlreadyReported() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn MultipleChoices() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn MovedPermanently() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Found() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn SeeOther() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn NotModified() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn UseProxy() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn TemporaryRedirect() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn PermanentRedirect() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn BadRequest() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn NotFound() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn PaymentRequired() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Forbidden() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn MethodNotAllowed() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn NotAcceptable() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn ProxyAuthenticationRequired() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn RequestTimeout() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Conflict() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn Gone() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn LengthRequired() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn PreconditionFailed() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn PreconditionRequired() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn PayloadTooLarge() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn UriTooLong() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn UnsupportedMediaType() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn RangeNotSatisfiable() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn ExpectationFailed() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn UnprocessableEntity() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn TooManyRequests() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn RequestHeaderFieldsTooLarge() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn InternalServerError() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn NotImplemented() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn BadGateway() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn GatewayTimeout() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn VersionNotSupported() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn VariantAlsoNegotiates() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn InsufficientStorage() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn LoopDetected() -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
sourceimpl HttpResponse<BoxBody>
impl HttpResponse<BoxBody>
sourcepub fn new(status: StatusCode) -> Self
pub fn new(status: StatusCode) -> Self
Constructs a response.
sourcepub fn build(status: StatusCode) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
pub fn build(status: StatusCode) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse, Error>;
Constructs a response builder with specific HTTP status.
sourcepub fn from_error(error: impl Into<Error>) -> Self
pub fn from_error(error: impl Into<Error>) -> Self
Create an error response.
sourceimpl<B> HttpResponse<B>
impl<B> HttpResponse<B>
sourcepub fn with_body(status: StatusCode, body: B) -> Self
pub fn with_body(status: StatusCode, body: B) -> Self
Constructs a response with body
sourcepub fn head(&self) -> &ResponseHead
pub fn head(&self) -> &ResponseHead
Returns a reference to response head.
sourcepub fn head_mut(&mut self) -> &mut ResponseHead
pub fn head_mut(&mut self) -> &mut ResponseHead
Returns a mutable reference to response head.
sourcepub fn status(&self) -> StatusCode
pub fn status(&self) -> StatusCode
Get the response status code
sourcepub fn status_mut(&mut self) -> &mut StatusCode
pub fn status_mut(&mut self) -> &mut StatusCode
Set the StatusCode for this response
sourcepub fn headers_mut(&mut self) -> &mut HeaderMap
pub fn headers_mut(&mut self) -> &mut HeaderMap
Get a mutable reference to the headers
Get an iterator for the cookies set by this response.
Add a cookie to this response.
Errors
Returns an error if the cookie results in a malformed Set-Cookie header.
Add a “removal” cookie to the response that matches attributes of given cookie.
This will cause browsers/clients to remove stored cookies with this name.
The Set-Cookie header added to the response will have:
- name matching given cookie;
- domain matching given cookie;
- path matching given cookie;
- an empty value;
- a max-age of
0; - an expiration date far in the past.
If the cookie you’re trying to remove has an explicit path or domain set, those attributes will need to be included in the cookie passed in here.
Errors
Returns an error if the given name results in a malformed Set-Cookie header.
Remove all cookies with the given name from this response.
Returns the number of cookies removed.
This method can not cause a browser/client to delete any of its stored cookies. Its only
purpose is to delete cookies that were added to this response using add_cookie
and add_removal_cookie. Use add_removal_cookie to send a “removal” cookie.
sourcepub fn keep_alive(&self) -> bool
pub fn keep_alive(&self) -> bool
Keep-alive status for this connection
sourcepub fn extensions(&self) -> Ref<'_, Extensions>
pub fn extensions(&self) -> Ref<'_, Extensions>
Returns reference to the response-local data/extensions container.
sourcepub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>
pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>
Returns reference to the response-local data/extensions container.
sourcepub fn set_body<B2>(self, body: B2) -> HttpResponse<B2>
pub fn set_body<B2>(self, body: B2) -> HttpResponse<B2>
Sets new body.
sourcepub fn into_parts(self) -> (HttpResponse<()>, B)
pub fn into_parts(self) -> (HttpResponse<()>, B)
Returns split head and body.
Implementation Notes
Due to internal performance optimizations, the first element of the returned tuple is an
HttpResponse as well but only contains the head of the response this was called on.
sourcepub fn drop_body(self) -> HttpResponse<()>
pub fn drop_body(self) -> HttpResponse<()>
Drops body and returns new response.
sourcepub fn map_body<F, B2>(self, f: F) -> HttpResponse<B2> where
F: FnOnce(&mut ResponseHead, B) -> B2,
pub fn map_body<F, B2>(self, f: F) -> HttpResponse<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.
sourcepub fn map_into_left_body<R>(self) -> HttpResponse<EitherBody<B, R>>
pub fn map_into_left_body<R>(self) -> HttpResponse<EitherBody<B, R>>
Map the current body type B to EitherBody::Left(B).
Useful for middleware which can generate their own responses.
sourcepub fn map_into_right_body<L>(self) -> HttpResponse<EitherBody<L, B>>
pub fn map_into_right_body<L>(self) -> HttpResponse<EitherBody<L, B>>
Map the current body type B to EitherBody::Right(B).
Useful for middleware which can generate their own responses.
sourcepub fn map_into_boxed_body(self) -> HttpResponse<BoxBody> where
B: MessageBody + 'static,
pub fn map_into_boxed_body(self) -> HttpResponse<BoxBody> where
B: MessageBody + 'static,
Map the current body to a type-erased BoxBody.
Trait Implementations
sourceimpl<B> Debug for HttpResponse<B> where
B: MessageBody,
impl<B> Debug for HttpResponse<B> where
B: MessageBody,
sourceimpl<B> From<HttpResponse<B>> for Response<B>
impl<B> From<HttpResponse<B>> for Response<B>
sourcefn from(res: HttpResponse<B>) -> Self
fn from(res: HttpResponse<B>) -> Self
Performs the conversion.
sourceimpl From<HttpResponseBuilder> for HttpResponse
impl From<HttpResponseBuilder> for HttpResponse
sourcefn from(builder: HttpResponseBuilder) -> Self
fn from(builder: HttpResponseBuilder) -> Self
Performs the conversion.
sourceimpl<B> From<Response<B>> for HttpResponse<B>
impl<B> From<Response<B>> for HttpResponse<B>
sourceimpl<B> From<ServiceResponse<B>> for HttpResponse<B>
impl<B> From<ServiceResponse<B>> for HttpResponse<B>
sourcefn from(res: ServiceResponse<B>) -> HttpResponse<B>
fn from(res: ServiceResponse<B>) -> HttpResponse<B>
Performs the conversion.
sourceimpl<B> Responder for HttpResponse<B> where
B: MessageBody + 'static,
impl<B> Responder for HttpResponse<B> where
B: MessageBody + 'static,
type Body = B
sourcefn respond_to(self, _: &HttpRequest) -> HttpResponse<Self::Body>
fn respond_to(self, _: &HttpRequest) -> HttpResponse<Self::Body>
Convert self to HttpResponse.
sourcefn customize(self) -> CustomizeResponder<Self> where
Self: Sized,
fn customize(self) -> CustomizeResponder<Self> where
Self: Sized,
Wraps responder to allow alteration of its response. Read more
Auto Trait Implementations
impl<B = BoxBody> !RefUnwindSafe for HttpResponse<B>
impl<B = BoxBody> !Send for HttpResponse<B>
impl<B = BoxBody> !Sync for HttpResponse<B>
impl<B> Unpin for HttpResponse<B> where
B: Unpin,
impl<B = BoxBody> !UnwindSafe for HttpResponse<B>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more