Struct actix_web::HttpResponseBuilder [−][src]
pub struct HttpResponseBuilder { /* fields omitted */ }
An HTTP response builder.
This type can be used to construct an instance of Response
through a builder-like pattern.
Implementations
impl HttpResponseBuilder
[src]
pub fn new(status: StatusCode) -> Self
[src]
Create response builder
pub fn status(&mut self, status: StatusCode) -> &mut Self
[src]
Set HTTP status code of this response.
pub fn insert_header<H>(&mut self, header: H) -> &mut Self where
H: IntoHeaderPair,
[src]
H: IntoHeaderPair,
Insert a header, replacing any that were set with an equivalent field name.
use actix_web::{HttpResponse, http::header}; HttpResponse::Ok() .insert_header(header::ContentType(mime::APPLICATION_JSON)) .insert_header(("X-TEST", "value")) .finish();
pub fn append_header<H>(&mut self, header: H) -> &mut Self where
H: IntoHeaderPair,
[src]
H: IntoHeaderPair,
Append a header, keeping any that were set with an equivalent field name.
use actix_web::{HttpResponse, http::header}; HttpResponse::Ok() .append_header(header::ContentType(mime::APPLICATION_JSON)) .append_header(("X-TEST", "value1")) .append_header(("X-TEST", "value2")) .finish();
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self where
K: TryInto<HeaderName>,
K::Error: Into<HttpError>,
V: IntoHeaderValue,
[src]
K: TryInto<HeaderName>,
K::Error: Into<HttpError>,
V: IntoHeaderValue,
Replaced with insert_header((key, value))
. Will be removed in v5.
Replaced with Self::insert_header()
.
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where
K: TryInto<HeaderName>,
K::Error: Into<HttpError>,
V: IntoHeaderValue,
[src]
K: TryInto<HeaderName>,
K::Error: Into<HttpError>,
V: IntoHeaderValue,
Replaced with append_header((key, value))
. Will be removed in v5.
Replaced with Self::append_header()
.
pub fn reason(&mut self, reason: &'static str) -> &mut Self
[src]
Set the custom reason for the response.
pub fn keep_alive(&mut self) -> &mut Self
[src]
Set connection type to KeepAlive
pub fn upgrade<V>(&mut self, value: V) -> &mut Self where
V: IntoHeaderValue,
[src]
V: IntoHeaderValue,
Set connection type to Upgrade
pub fn force_close(&mut self) -> &mut Self
[src]
Force close connection, even if it is marked as keep-alive
pub fn no_chunking(&mut self, len: u64) -> &mut Self
[src]
Disable chunked transfer encoding for HTTP/1.1 streaming responses.
pub fn content_type<V>(&mut self, value: V) -> &mut Self where
V: IntoHeaderValue,
[src]
V: IntoHeaderValue,
Set response content type.
pub fn cookie<'c>(&mut self, cookie: Cookie<'c>) -> &mut Self
[src]
Set a cookie.
use actix_web::{HttpResponse, cookie::Cookie}; HttpResponse::Ok() .cookie( Cookie::build("name", "value") .domain("www.rust-lang.org") .path("/") .secure(true) .http_only(true) .finish(), ) .finish();
pub fn del_cookie(&mut self, cookie: &Cookie<'_>) -> &mut Self
[src]
Remove cookie.
A Set-Cookie
header is added that will delete a cookie with the same name from the client.
use actix_web::{HttpRequest, HttpResponse, Responder}; async fn handler(req: HttpRequest) -> impl Responder { let mut builder = HttpResponse::Ok(); if let Some(ref cookie) = req.cookie("name") { builder.del_cookie(cookie); } builder.finish() }
pub fn extensions(&self) -> Ref<'_, Extensions>
[src]
Responses extensions
pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>
[src]
Mutable reference to a the response’s extensions
pub fn body<B: Into<Body>>(&mut self, body: B) -> HttpResponseⓘNotable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
[src]
Notable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
Set a body and generate Response
.
HttpResponseBuilder
can not be used after this call.
pub fn message_body<B>(&mut self, body: B) -> HttpResponse<B>ⓘNotable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
[src]
Notable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
Set a body and generate Response
.
HttpResponseBuilder
can not be used after this call.
pub fn streaming<S, E>(&mut self, stream: S) -> HttpResponseⓘNotable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
where
S: Stream<Item = Result<Bytes, E>> + Unpin + 'static,
E: Into<Error> + 'static,
[src]
Notable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
S: Stream<Item = Result<Bytes, E>> + Unpin + 'static,
E: Into<Error> + 'static,
Set a streaming body and generate Response
.
HttpResponseBuilder
can not be used after this call.
pub fn json(&mut self, value: impl Serialize) -> HttpResponseⓘNotable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
[src]
Notable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
Set a json body and generate Response
HttpResponseBuilder
can not be used after this call.
pub fn finish(&mut self) -> HttpResponseⓘNotable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
[src]
Notable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
Set an empty body and generate Response
HttpResponseBuilder
can not be used after this call.
pub fn take(&mut self) -> Self
[src]
This method construct new HttpResponseBuilder
Trait Implementations
impl BodyEncoding for HttpResponseBuilder
[src]
fn get_encoding(&self) -> Option<ContentEncoding>
[src]
fn encoding(&mut self, encoding: ContentEncoding) -> &mut Self
[src]
impl From<HttpResponseBuilder> for HttpResponse
[src]
fn from(builder: HttpResponseBuilder) -> Self
[src]
impl From<HttpResponseBuilder> for Response<Body>
[src]
fn from(builder: HttpResponseBuilder) -> Self
[src]
impl Future for HttpResponseBuilder
[src]
type Output = Result<HttpResponse, Error>
The type of value produced on completion.
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Self::Output>
[src]
impl Responder for HttpResponseBuilder
[src]
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘNotable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
[src]
Notable traits for HttpResponse
impl Future for HttpResponse type Output = Result<Response<Body>, Error>;
fn with_status(self, status: StatusCode) -> CustomResponder<Self> where
Self: Sized,
[src]
Self: Sized,
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
[src]
Self: Sized,
H: IntoHeaderPair,
Auto Trait Implementations
impl !RefUnwindSafe for HttpResponseBuilder
impl !Send for HttpResponseBuilder
impl !Sync for HttpResponseBuilder
impl Unpin for HttpResponseBuilder
impl !UnwindSafe for HttpResponseBuilder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> FutureExt for T where
T: Future + ?Sized,
[src]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
[src]
Self::Output: Into<U>,
pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
[src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>
[src]
pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
[src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>
[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
pub fn shared(self) -> Shared<Self> where
Self::Output: Clone,
[src]
Self::Output: Clone,
pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
[src]
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
[src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
[src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
pub fn unit_error(self) -> UnitError<Self>
[src]
pub fn never_error(self) -> NeverError<Self>
[src]
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,
pub fn now_or_never(self) -> Option<Self::Output>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,
[src]
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
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
[src]
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
[src]
Fut: TryFuture + ?Sized,
pub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
[src]
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,
[src]
F: FnOnce(Self::Ok) -> T,
pub 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,
[src]
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T,
pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
F: FnOnce(Self::Error) -> E,
pub fn err_into<E>(self) -> ErrInto<Self, E> where
Self::Error: Into<E>,
[src]
Self::Error: Into<E>,
pub fn ok_into<U>(self) -> OkInto<Self, U> where
Self::Ok: Into<U>,
[src]
Self::Ok: Into<U>,
pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
[src]
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
[src]
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
[src]
F: FnOnce(&Self::Ok),
pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
[src]
F: FnOnce(&Self::Error),
pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
[src]
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
[src]
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
pub fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
[src]
F: FnOnce(Self::Error) -> Self::Ok,
pub fn into_future(self) -> IntoFuture<Self>
[src]
pub fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,