Struct Response 

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

An HTTP response.

Implementations

impl Response

pub fn Ok() -> ResponseBuilder

pub fn Created() -> ResponseBuilder

pub fn Accepted() -> ResponseBuilder

pub fn NonAuthoritativeInformation() -> ResponseBuilder

pub fn NoContent() -> ResponseBuilder

pub fn ResetContent() -> ResponseBuilder

pub fn PartialContent() -> ResponseBuilder

pub fn MultiStatus() -> ResponseBuilder

pub fn AlreadyReported() -> ResponseBuilder

pub fn MultipleChoices() -> ResponseBuilder

pub fn MovedPermanently() -> ResponseBuilder

pub fn Found() -> ResponseBuilder

pub fn SeeOther() -> ResponseBuilder

pub fn NotModified() -> ResponseBuilder

pub fn UseProxy() -> ResponseBuilder

pub fn TemporaryRedirect() -> ResponseBuilder

pub fn PermanentRedirect() -> ResponseBuilder

pub fn BadRequest() -> ResponseBuilder

pub fn NotFound() -> ResponseBuilder

pub fn Unauthorized() -> ResponseBuilder

pub fn PaymentRequired() -> ResponseBuilder

pub fn Forbidden() -> ResponseBuilder

pub fn MethodNotAllowed() -> ResponseBuilder

pub fn NotAcceptable() -> ResponseBuilder

pub fn ProxyAuthenticationRequired() -> ResponseBuilder

pub fn RequestTimeout() -> ResponseBuilder

pub fn Conflict() -> ResponseBuilder

pub fn Gone() -> ResponseBuilder

pub fn LengthRequired() -> ResponseBuilder

pub fn PreconditionFailed() -> ResponseBuilder

pub fn PreconditionRequired() -> ResponseBuilder

pub fn PayloadTooLarge() -> ResponseBuilder

pub fn UriTooLong() -> ResponseBuilder

pub fn UnsupportedMediaType() -> ResponseBuilder

pub fn RangeNotSatisfiable() -> ResponseBuilder

pub fn ExpectationFailed() -> ResponseBuilder

pub fn MisdirectedRequest() -> ResponseBuilder

pub fn UnprocessableEntity() -> ResponseBuilder

pub fn Locaked() -> ResponseBuilder

pub fn FailedDependency() -> ResponseBuilder

pub fn TooEarly() -> ResponseBuilder

pub fn UpgradeRequired() -> ResponseBuilder

pub fn TooManyRequests() -> ResponseBuilder

pub fn RequestHeaderFieldsTooLarge() -> ResponseBuilder

pub fn InternalServerError() -> ResponseBuilder

pub fn NotImplemented() -> ResponseBuilder

pub fn BadGateway() -> ResponseBuilder

pub fn ServiceUnavailable() -> ResponseBuilder

pub fn GatewayTimeout() -> ResponseBuilder

pub fn VersionNotSupported() -> ResponseBuilder

pub fn VariantAlsoNegotiates() -> ResponseBuilder

pub fn InsufficientStorage() -> ResponseBuilder

pub fn LoopDetected() -> ResponseBuilder

impl Response<Body>

pub fn builder(status: StatusCode) -> ResponseBuilder

Creates a response builder with the given status.

pub fn builder_from<T: Into<ResponseBuilder>>(source: T) -> ResponseBuilder

Creates a response builder from another compatible value.

pub fn new(status: StatusCode) -> Response

Constructs a response.

pub fn render_with<B: Display>(status: StatusCode, body: &B) -> Response

Renders a displayable value as a plain-text response body.

pub fn into_body<B>(self) -> Response<B>

Converts the default body into a custom response body type.

impl<B> Response<B>

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

Creates a response with the given status and body.

pub fn head(&self) -> &ResponseHead

Returns the response head.

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

Returns mutable access to the response head.

pub fn status(&self) -> StatusCode

Returns the response status code.

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

Returns mutable access to the response status code.

pub fn headers(&self) -> &HeaderMap

Returns the response headers.

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

Returns mutable access to the response headers.

pub fn cookies(&self) -> CookieIter<'_>

Get an iterator for the cookies set by this response.

pub fn add_cookie<'a, C>(&mut self, cookie: C) -> Result<(), HttpError>

where C: Into<Cookie<'a>>,

Add a cookie to this response.

pub fn del_cookie(&mut self, name: &str) -> usize

Remove all cookies with the given name from this response.

Returns the number of cookies removed.

pub fn upgrade(&self) -> bool

Connection upgrade status.

pub fn keep_alive(&self) -> bool

Keep-alive status for this connection.

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

Returns the response extensions.

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

Returns mutable access to the response extensions.

pub fn body(&self) -> &ResponseBody<B>

Returns the response body.

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

Replaces the response body with a different body type.

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

Splits the response into its metadata and body.

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

Drops the response body while preserving the response head.

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

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

Transforms the response body and allows its metadata to be updated.

pub fn take_body(&mut self) -> ResponseBody<B>

Takes the response body, leaving an empty body behind.

impl Response<Body>

pub fn take(&mut self) -> Response

Takes the response body while preserving its metadata.

The returned response contains the original body and a copy of the response head without its extensions. This response is left with an empty body, both responses can be modified independently.

Trait Implementations

impl<B> BodyEncoding for HttpResponse<B>

fn get_encoding(&self) -> Option<ContentEncoding>

Get content encoding

fn encoding(&mut self, encoding: ContentEncoding) -> &mut Self

Set content encoding

impl<B: MessageBody> Debug for Response<B>

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

Formats the value using the given formatter.

impl<B: MessageBody> Display for Response<B>

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

Formats the value using the given formatter.

impl<B: MessageBody> Error for Response<B>

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<'a> From<&'a String> for Response

fn from(val: &'a String) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&'static str> for Response

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

Converts to this type from the input type.

impl From<Bytes> for Response

fn from(val: Bytes) -> Self

Converts to this type from the input type.

impl From<BytesMut> for Response

fn from(val: BytesMut) -> 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<ResponseBuilder> for Response

fn from(builder: ResponseBuilder) -> Self

Converts to this type from the input type.

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

where E: ResponseError + Debug,

Helper converters

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

Converts to this type from the input type.

impl From<String> for Response

fn from(val: String) -> Self

Converts to this type from the input type.

impl<T: ResponseError> From<T> for Response

fn from(err: T) -> Response

Converts to this type from the input type.

impl From<WebResponse> for Response<Body>

fn from(res: WebResponse) -> Response<Body>

Converts to this type from the input type.

impl<St: State> Responder<St> for Response

async fn respond_to(self, _: &St, _: &HttpRequest) -> Response

Builds an HTTP response from this value.

fn with_status(self, status: StatusCode) -> CustomResponder<Self, St>

where Self: Sized,

Replaces the status code produced by this responder.

fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self, St>

where Self: Sized, HeaderName: TryFrom<K>, HeaderValue: TryFrom<V>, <HeaderName as TryFrom<K>>::Error: Into<HttpError>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Sets a header on the response produced by this responder.