Struct ajars_actix_web::actix_web::HttpResponseBuilder [−][src]
pub struct HttpResponseBuilder { /* fields omitted */ }
Expand description
An HTTP response builder.
This type can be used to construct an instance of Response
through a builder-like pattern.
Implementations
pub fn new(status: StatusCode) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn new(status: StatusCode) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Create response builder
pub fn status(&mut self, status: StatusCode) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn status(&mut self, status: StatusCode) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Set HTTP status code of this response.
pub fn insert_header<H>(&mut self, header: H) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
H: IntoHeaderPair,
pub fn insert_header<H>(&mut self, header: H) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
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 HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
H: IntoHeaderPair,
pub fn append_header<H>(&mut self, header: H) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
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 HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
K: TryInto<HeaderName>,
V: IntoHeaderValue,
<K as TryInto<HeaderName>>::Error: Into<Error>,
👎 Deprecated since 4.0.0: Replaced with insert_header((key, value))
. Will be removed in v5.
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
K: TryInto<HeaderName>,
V: IntoHeaderValue,
<K as TryInto<HeaderName>>::Error: Into<Error>,
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 HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
K: TryInto<HeaderName>,
V: IntoHeaderValue,
<K as TryInto<HeaderName>>::Error: Into<Error>,
👎 Deprecated since 4.0.0: Replaced with append_header((key, value))
. Will be removed in v5.
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
K: TryInto<HeaderName>,
V: IntoHeaderValue,
<K as TryInto<HeaderName>>::Error: Into<Error>,
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 HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn reason(&mut self, reason: &'static str) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Set the custom reason for the response.
pub fn keep_alive(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn keep_alive(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Set connection type to KeepAlive
pub fn upgrade<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
V: IntoHeaderValue,
pub fn upgrade<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
V: IntoHeaderValue,
Set connection type to Upgrade
pub fn force_close(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn force_close(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Force close connection, even if it is marked as keep-alive
pub fn no_chunking(&mut self, len: u64) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn no_chunking(&mut self, len: u64) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Disable chunked transfer encoding for HTTP/1.1 streaming responses.
pub fn content_type<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
V: IntoHeaderValue,
pub fn content_type<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
where
V: IntoHeaderValue,
Set response content type.
Responses extensions
Mutable reference to a the response’s extensions
Set a body and generate Response
.
HttpResponseBuilder
can not be used after this call.
Set a body and generate Response
.
HttpResponseBuilder
can not be used after this call.
pub fn streaming<S, E>(&mut self, stream: S) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
where
E: Into<Box<dyn Error + 'static, Global>> + 'static,
S: Stream<Item = Result<Bytes, E>> + Unpin + 'static,
pub fn streaming<S, E>(&mut self, stream: S) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
where
E: Into<Box<dyn Error + 'static, Global>> + 'static,
S: Stream<Item = Result<Bytes, E>> + Unpin + '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<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
pub fn json(&mut self, value: impl Serialize) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
Set a json body and generate Response
HttpResponseBuilder
can not be used after this call.
pub fn finish(&mut self) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
pub fn finish(&mut self) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
Set an empty body and generate Response
HttpResponseBuilder
can not be used after this call.
pub fn take(&mut self) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn take(&mut self) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
This method construct new HttpResponseBuilder
Trait Implementations
Get content encoding
pub fn encoding(
&mut self,
encoding: ContentEncoding
) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
pub fn encoding(
&mut self,
encoding: ContentEncoding
) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilder
impl Future for HttpResponseBuilder type Output = Result<HttpResponse<AnyBody>, Error>;
Set content encoding Read more
Performs the conversion.
pub fn from(builder: HttpResponseBuilder) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
pub fn from(builder: HttpResponseBuilder) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
Performs the conversion.
type Output = Result<HttpResponse<AnyBody>, Error>
type Output = Result<HttpResponse<AnyBody>, Error>
The type of value produced on completion.
pub fn poll(
self: Pin<&mut HttpResponseBuilder>,
&mut Context<'_>
) -> Poll<<HttpResponseBuilder as Future>::Output>
pub fn poll(
self: Pin<&mut HttpResponseBuilder>,
&mut Context<'_>
) -> Poll<<HttpResponseBuilder as Future>::Output>
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
pub fn respond_to(self, &HttpRequest) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
pub fn respond_to(self, &HttpRequest) -> HttpResponse<AnyBody>ⓘNotable traits for HttpResponse<AnyBody>
impl Future for HttpResponse<AnyBody> type Output = Result<Response<AnyBody>, Error>;
Convert self to HttpResponse
.
Override a status code for a Responder. Read more
Insert header to the final response. Read more
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
Mutably borrows from an owned value. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
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>,
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
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>,
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the right-hand variant
of that Either
. Read more
fn into_stream(self) -> IntoStream<Self>
fn into_stream(self) -> IntoStream<Self>
Convert this future into a single element stream. Read more
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,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self>
fn fuse(self) -> Fuse<Self>
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
Do something with the output of a future before passing it on. Read more
Wrap the future in a Box, pinning it. Read more
Wrap the future in a Box, pinning it. Read more
fn unit_error(self) -> UnitError<Self>
fn unit_error(self) -> UnitError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
fn never_error(self) -> NeverError<Self>
fn never_error(self) -> NeverError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>. Read more
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
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>
fn now_or_never(self) -> Option<Self::Output>
Evaluates and consumes the future, returning the resulting output if
the future is ready after the first call to Future::poll
. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
into_future
)Creates a future from a value.
type Output = T
type Output = T
Should always be Self
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
Flattens the execution of this future when the successful result of this
future is a [Sink
]. Read more
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
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more
Maps this future’s error value to a different value. Read more
Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more
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),
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
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),
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
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,
<Self::Ok as TryFuture>::Error == Self::Error,
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
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,
<Self::Ok as TryStream>::Error == Self::Error,
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
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
F: FnOnce(Self::Error) -> Self::Ok,
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
fn into_future(self) -> IntoFuture<Self>
fn into_future(self) -> IntoFuture<Self>
pub fn vzip(self) -> V