Struct ntex::http::Response

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

Expand description

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 UnprocessableEntity() -> ResponseBuilder

pub fn TooManyRequests() -> 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 build(status: StatusCode) -> ResponseBuilder

Create http response builder with specific status.

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

Create http response builder

pub fn new(status: StatusCode) -> Response

Constructs a response

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

Convert response to response with body

impl<B> Response<B>

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

Constructs a response with body

pub fn head(&self) -> &ResponseHead

Http message part of the response

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

Mutable reference to a http message part of the response

pub fn status(&self) -> StatusCode

Get the response status code

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

Set the StatusCode for this response

pub fn headers(&self) -> &HeaderMap

Get the headers from the response

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

Get a mutable reference to the 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>

Responses extensions

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

Mutable reference to a the response’s extensions

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

Get body of this response

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

Set a body

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

Split response and body

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

Drop request’s body

pub fn map_body<F, B2>(self, f: F) -> Response<B2>
where F: FnOnce(&mut ResponseHead, ResponseBody<B>) -> ResponseBody<B2>,

Set a body and return previous body value

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

Extract response body

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. Read more

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

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

Converts to this type from the input type.

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

fn from(val: &'a String) -> 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<Err: ErrorRenderer> Responder<Err> for Response

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

Convert itself to http response.

fn with_status(self, status: StatusCode) -> CustomResponder<Self, Err>
where Self: Sized,

Override a status code for a Responder. Read more

fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self, Err>
where Self: Sized, HeaderName: TryFrom<K>, HeaderValue: TryFrom<V>, <HeaderName as TryFrom<K>>::Error: Into<HttpError>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Add header to the Responder’s response. Read more

Auto Trait Implementations§

impl<B> Freeze for Response<B>
where B: Freeze,

impl<B = Body> !RefUnwindSafe for Response<B>

impl<B = Body> !Send for Response<B>

impl<B = Body> !Sync for Response<B>

impl<B> Unpin for Response<B>
where B: Unpin,

impl<B = Body> !UnwindSafe for Response<B>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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