Struct actix_web::dev::Response

source · [−]

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

Expand description

An HTTP response.

Implementations

source

impl Response<BoxBody>

source

pub fn new(status: StatusCode) -> Response<BoxBody>

Constructs a new response with default body.

source

pub fn build(status: StatusCode) -> ResponseBuilder

Constructs a new response builder.

source

pub fn ok() -> Response<BoxBody>

Constructs a new response with status 200 OK.

source

pub fn bad_request() -> Response<BoxBody>

Constructs a new response with status 400 Bad Request.

source

pub fn not_found() -> Response<BoxBody>

Constructs a new response with status 404 Not Found.

source

pub fn internal_server_error() -> Response<BoxBody>

Constructs a new response with status 500 Internal Server Error.

source

impl Response

source

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

Constructs a new response with given body.

source

pub fn head(&self) -> &ResponseHead

Returns a reference to the head of this response.

source

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

Returns a mutable reference to the head of this response.

source

pub fn status(&self) -> StatusCode

Returns the status code of this response.

source

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

Returns a mutable reference the status code of this response.

source

pub fn headers(&self) -> &HeaderMap

Returns a reference to response headers.

source

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

Returns a mutable reference to response headers.

source

pub fn upgrade(&self) -> bool

Returns true if connection upgrade is enabled.

source

pub fn keep_alive(&self) -> bool

Returns true if keep-alive is enabled.

source

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

Returns a reference to the request-local data/extensions container.

source

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

Returns a mutable reference to the request-local data/extensions container.

source

pub fn body(&self) -> &B

Returns a reference to the body of this response.

source

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

Sets new body.

source

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

Drops body and returns new response.

source

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.

source

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. Returns a new response.

Closure receives the response head and the current body type.

source

pub fn map_into_boxed_body(self) -> Response<BoxBody> where
B: 'static + MessageBody,

source

pub fn into_body(self) -> B

Returns body, consuming this response.

Trait Implementations

source

impl Debug for Response where
B: MessageBody,

source

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

Formats the value using the given formatter. Read more

source

impl Default for Response where
B: Default,

source

pub fn default() -> Response

Returns the “default value” for a type. Read more

source

impl<'_> From<&'_ HandshakeError> for Response<BoxBody>

source

pub fn from(err: &HandshakeError) -> Response<BoxBody>

Performs the conversion.

source

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

source

pub fn from(val: &String) -> Response<String>

Performs the conversion.

source

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

source

pub fn from(val: &'static [u8 ]) -> Response<&'static [u8 ]>

Performs the conversion.

source

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

source

pub fn from(val: &'static str) -> Response<&'static str>

Performs the conversion.

source

impl From<ByteString> for Response<ByteString>

source

pub fn from(val: ByteString) -> Response<ByteString>

Performs the conversion.

source

impl From<Bytes> for Response<Bytes>

source

pub fn from(val: Bytes) -> Response<Bytes>

Performs the conversion.

source

impl From<BytesMut> for Response<BytesMut>

source

pub fn from(val: BytesMut) -> Response<BytesMut>

Performs the conversion.

source

impl<E, U, I> From<DispatcherError<E, U, I>> for Response<BoxBody> where
 E: Debug + Display,
 U: Encoder + Decoder,
 >::Error: Debug,
 ::Error: Debug,

source

pub fn from(err: DispatcherError<E, U, I>) -> Response<BoxBody>

Performs the conversion.

source

impl From<Error> for Response<BoxBody>

source

pub fn from(err: Error) -> Response<BoxBody>

Performs the conversion.

source

impl From<Error> for Response<BoxBody>

source

fn from(err: Error) -> Response<BoxBody>

Performs the conversion.

source

impl From<HandshakeError> for Response<BoxBody>

source

pub fn from(err: HandshakeError) -> Response<BoxBody>

Performs the conversion.

source

impl From<HttpResponse> for Response

source

fn from(res: HttpResponse) -> Self

Performs the conversion.

source

impl From<HttpResponseBuilder> for Response<BoxBody>

source

fn from(builder: HttpResponseBuilder) -> Self

Performs the conversion.

source

impl From<Infallible> for Response<BoxBody>

source

pub fn from(val: Infallible) -> Response<BoxBody>

Performs the conversion.

source

impl From<ParseError> for Response<BoxBody>

source

pub fn from(err: ParseError) -> Response<BoxBody>

Performs the conversion.

source

impl From<Response> for HttpResponse

source

fn from(res: Response) -> Self

Performs the conversion.

source

impl From<Response<BoxBody>> for DispatchError

source

pub fn from(original: Response<BoxBody>) -> DispatchError

Performs the conversion.

source

impl From<ResponseBuilder> for Response<EitherBody<(), BoxBody>>

source

pub fn from(builder: ResponseBuilder) -> Response<EitherBody<(), BoxBody>>

Performs the conversion.

source

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

source

pub fn from(res: Result<I, E>) -> Response<BoxBody>

Performs the conversion.

source

impl From<ServiceResponse> for Response

source

fn from(res: ServiceResponse) -> Response

Performs the conversion.

source

impl From<String> for Response<String>

source

pub fn from(val: String) -> Response<String>

Performs the conversion.

source

impl Responder for Response<BoxBody>

type Body = BoxBody

source

fn respond_to(self, _: &HttpRequest) -> HttpResponse<Self::Body>ⓘ
Notable traits for HttpResponse<BoxBody>
`impl Future for HttpResponse<BoxBody> type Output = Result<Response<BoxBody>, Error>;`

Convert self to HttpResponse.

source

fn customize(self) -> CustomizeResponder<Self> where
Self: Sized,

Wraps responder to allow alteration of its response. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Response

impl !Send for Response

impl !Sync for Response

impl Unpin for Response where
B: Unpin,

impl !UnwindSafe for Response

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct actix_web::dev::Response

Implementations

impl Response<BoxBody>

pub fn new(status: StatusCode) -> Response<BoxBody>

pub fn build(status: StatusCode) -> ResponseBuilder

pub fn ok() -> Response<BoxBody>

pub fn bad_request() -> Response<BoxBody>

pub fn not_found() -> Response<BoxBody>

pub fn internal_server_error() -> Response<BoxBody>

impl<B> Response<B>

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

pub fn head(&self) -> &ResponseHead

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

pub fn status(&self) -> StatusCode

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

pub fn headers(&self) -> &HeaderMap

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

pub fn upgrade(&self) -> bool

pub fn keep_alive(&self) -> bool

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

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

pub fn body(&self) -> &B

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

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

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

Implementation Notes

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

pub fn map_into_boxed_body(self) -> Response<BoxBody> where B: 'static + MessageBody,

pub fn into_body(self) -> B

Trait Implementations

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

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

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

pub fn default() -> Response<B>

impl<'_> From<&'_ HandshakeError> for Response<BoxBody>

pub fn from(err: &HandshakeError) -> Response<BoxBody>

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

pub fn from(val: &String) -> Response<String>

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

pub fn from(val: &'static [u8]) -> Response<&'static [u8]>

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

pub fn from(val: &'static str) -> Response<&'static str>

impl From<ByteString> for Response<ByteString>

pub fn from(val: ByteString) -> Response<ByteString>

impl From<Bytes> for Response<Bytes>

pub fn from(val: Bytes) -> Response<Bytes>

impl From<BytesMut> for Response<BytesMut>

pub fn from(val: BytesMut) -> Response<BytesMut>

impl<E, U, I> From<DispatcherError<E, U, I>> for Response<BoxBody> where E: Debug + Display, U: Encoder<I> + Decoder, <U as Encoder<I>>::Error: Debug, <U as Decoder>::Error: Debug,

pub fn from(err: DispatcherError<E, U, I>) -> Response<BoxBody>

impl From<Error> for Response<BoxBody>

pub fn from(err: Error) -> Response<BoxBody>

impl From<Error> for Response<BoxBody>

fn from(err: Error) -> Response<BoxBody>

impl From<HandshakeError> for Response<BoxBody>

pub fn from(err: HandshakeError) -> Response<BoxBody>

impl<B> From<HttpResponse<B>> for Response<B>

fn from(res: HttpResponse<B>) -> Self

impl From<HttpResponseBuilder> for Response<BoxBody>

fn from(builder: HttpResponseBuilder) -> Self

impl From<Infallible> for Response<BoxBody>

pub fn from(val: Infallible) -> Response<BoxBody>

impl From<ParseError> for Response<BoxBody>

pub fn from(err: ParseError) -> Response<BoxBody>

impl<B> From<Response<B>> for HttpResponse<B>

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

impl From<Response<BoxBody>> for DispatchError

pub fn from(original: Response<BoxBody>) -> DispatchError

impl From<ResponseBuilder> for Response<EitherBody<(), BoxBody>>

pub fn from(builder: ResponseBuilder) -> Response<EitherBody<(), BoxBody>>

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

pub fn from(res: Result<I, E>) -> Response<BoxBody>

impl<B> From<ServiceResponse<B>> for Response<B>

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

impl From<String> for Response<String>

pub fn from(val: String) -> Response<String>

impl Responder for Response<BoxBody>

type Body = BoxBody

fn respond_to(self, _: &HttpRequest) -> HttpResponse<Self::Body>ⓘNotable traits for HttpResponse<BoxBody>impl Future for HttpResponse<BoxBody> type Output = Result<Response<BoxBody>, Error>;

fn customize(self) -> CustomizeResponder<Self> where Self: Sized,

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

pub fn map_into_boxed_body(self) -> Response<BoxBody> where
B: 'static + MessageBody,

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

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

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

pub fn from(val: &'static [u8 ]) -> Response<&'static [u8 ]>

impl<E, U, I> From<DispatcherError<E, U, I>> for Response<BoxBody> where
E: Debug + Display,
U: Encoder<I> + Decoder,
<U as Encoder<I>>::Error: Debug,
<U as Decoder>::Error: Debug,

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

fn respond_to(self, _: &HttpRequest) -> HttpResponse<Self::Body>ⓘ
Notable traits for HttpResponse<BoxBody>
`impl Future for HttpResponse<BoxBody> type Output = Result<Response<BoxBody>, Error>;`

fn customize(self) -> CustomizeResponder<Self> where
Self: Sized,

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,