Struct 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 from_error(error: Error) -> Response ⓘ

Constructs an error 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 error(&self) -> Option<&Error>

The source error for this 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(&mut self, cookie: &Cookie<'_>) -> Result<(), HttpError>

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(&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: 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 From<Error> for Response

Convert Error to a Response instance

fn from(err: Error) -> 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> for Error

Convert Response to a Error

fn from(res: Response) -> Error

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: Into<Error>> From<Result<I, E>> for Response

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 Future for Response

type Output = Result<Response, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

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

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>

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> FutureExt for T
where T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F>
where F: FnOnce(Self::Output) -> U, Self: Sized,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn map_into<U>(self) -> MapInto<Self, U>
where Self::Output: Into<U>, Self: Sized,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>
where F: FnOnce(Self::Output) -> Fut, Fut: Future, Self: Sized,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn left_future<B>(self) -> Either<Self, B>
where B: Future<Output = Self::Output>, Self: Sized,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self>
where A: Future<Output = Self::Output>, Self: Sized,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>
where Self: Sized,

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self>
where Self::Output: Future, Self: Sized,

Flatten the execution of this future when the output of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self>
where Self::Output: Stream, Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F>
where F: FnOnce(&Self::Output), Self: Sized,

Do something with the output of a future before passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self>
where Self: Sized + UnwindSafe,

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self>
where Self: Sized, Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
where Self: Sized,

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a>>
where Self: Sized + Send + 'a,

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>>
where Self: Sized + 'a,

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>
where Self: Sized,

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>.

fn never_error(self) -> NeverError<Self>
where Self: Sized,

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>.

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>
where Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

fn now_or_never(self) -> Option<Self::Output>
where Self: Sized,

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

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> 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> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<F> IntoFuture for F
where F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

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<F, T, E> TryFuture for F
where F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>, ) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

impl<Fut> TryFutureExt for Fut
where Fut: TryFuture + ?Sized,

fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok>
where Self::Ok: Sink<Item, Error = Self::Error>, Self: Sized,

Flattens the execution of this future when the successful result of this future is a Sink. Read more

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>
where F: FnOnce(Self::Ok) -> T, Self: Sized,

Maps this future’s success value to a different value. Read more

fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E>
where F: FnOnce(Self::Ok) -> T, E: FnOnce(Self::Error) -> T, Self: Sized,

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>
where F: FnOnce(Self::Error) -> E, Self: Sized,

Maps this future’s error value to a different value. Read more

fn err_into<E>(self) -> ErrInto<Self, E>
where Self: Sized, Self::Error: Into<E>,

Maps this future’s Error to a new error type using the Into trait. Read more

fn ok_into<U>(self) -> OkInto<Self, U>
where Self: Sized, Self::Ok: Into<U>,

Maps this future’s Ok to a new type using the Into trait.

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>
where F: FnOnce(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>, Self: Sized,

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>
where F: FnOnce(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>, Self: Sized,

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>
where F: FnOnce(&Self::Ok), Self: Sized,

Do something with the success value of a future before passing it on. Read more

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>
where F: FnOnce(&Self::Error), Self: Sized,

Do something with the error value of a future before passing it on. Read more

fn try_flatten(self) -> TryFlatten<Self, Self::Ok>
where Self::Ok: TryFuture<Error = Self::Error>, Self: Sized,

Flatten the execution of this future when the successful result of this future is another future. Read more

fn try_flatten_stream(self) -> TryFlattenStream<Self>
where Self::Ok: TryStream<Error = Self::Error>, Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> Self::Ok,

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

fn into_future(self) -> IntoFuture<Self>
where Self: Sized,

Wraps a TryFuture into a type that implements Future. Read more

fn try_poll_unpin( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Self::Ok, Self::Error>>
where Self: Unpin,

A convenience method for calling TryFuture::try_poll on Unpin future types.

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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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

impl<T> ErasedDestructor for T
where T: 'static,