Struct ajars_actix_web::actix_web::HttpResponseBuilder
source · [−]pub struct HttpResponseBuilder { /* private fields */ }
Expand description
An HTTP response builder.
This type can be used to construct an instance of Response
through a builder-like pattern.
Implementations
sourceimpl HttpResponseBuilder
impl HttpResponseBuilder
sourcepub fn new(status: StatusCode) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn new(status: StatusCode) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
Create response builder
sourcepub fn status(&mut self, status: StatusCode) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn status(&mut self, status: StatusCode) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
Set HTTP status code of this response.
sourcepub fn insert_header(
&mut self,
header: impl TryIntoHeaderPair
) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn insert_header(
&mut self,
header: impl TryIntoHeaderPair
) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
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();
sourcepub fn append_header(
&mut self,
header: impl TryIntoHeaderPair
) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn append_header(
&mut self,
header: impl TryIntoHeaderPair
) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
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();
sourcepub fn reason(&mut self, reason: &'static str) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn reason(&mut self, reason: &'static str) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
Set the custom reason for the response.
sourcepub fn keep_alive(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn keep_alive(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
Set connection type to KeepAlive
sourcepub fn upgrade<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
where
V: TryIntoHeaderValue,
pub fn upgrade<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
where
V: TryIntoHeaderValue,
Set connection type to Upgrade
sourcepub fn force_close(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn force_close(&mut self) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
Force close connection, even if it is marked as keep-alive
sourcepub fn no_chunking(&mut self, len: u64) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn no_chunking(&mut self, len: u64) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
Disable chunked transfer encoding for HTTP/1.1 streaming responses.
sourcepub fn content_type<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
where
V: TryIntoHeaderValue,
pub fn content_type<V>(&mut self, value: V) -> &mut HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
where
V: TryIntoHeaderValue,
Set response content type.
sourcepub fn extensions(&self) -> Ref<'_, Extensions>
pub fn extensions(&self) -> Ref<'_, Extensions>
Returns a reference to the response-local data/extensions container.
sourcepub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>
pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>
Returns a mutable reference to the response-local data/extensions container.
sourcepub fn body<B>(&mut self, body: B) -> HttpResponse<BoxBody> where
B: 'static + MessageBody,
pub fn body<B>(&mut self, body: B) -> HttpResponse<BoxBody> where
B: 'static + MessageBody,
Set a body and build the HttpResponse
.
Unlike message_body
, errors are converted into error
responses immediately.
HttpResponseBuilder
can not be used after this call.
sourcepub fn message_body<B>(&mut self, body: B) -> Result<HttpResponse<B>, Error>
pub fn message_body<B>(&mut self, body: B) -> Result<HttpResponse<B>, Error>
Set a body and build the HttpResponse
.
HttpResponseBuilder
can not be used after this call.
sourcepub fn streaming<S, E>(&mut self, stream: S) -> HttpResponse<BoxBody> where
S: 'static + Stream<Item = Result<Bytes, E>>,
E: 'static + Into<Box<dyn Error + 'static, Global>>,
pub fn streaming<S, E>(&mut self, stream: S) -> HttpResponse<BoxBody> where
S: 'static + Stream<Item = Result<Bytes, E>>,
E: 'static + Into<Box<dyn Error + 'static, Global>>,
Set a streaming body and build the HttpResponse
.
HttpResponseBuilder
can not be used after this call.
sourcepub fn json(&mut self, value: impl Serialize) -> HttpResponse<BoxBody>
pub fn json(&mut self, value: impl Serialize) -> HttpResponse<BoxBody>
Set a JSON body and build the HttpResponse
.
HttpResponseBuilder
can not be used after this call.
sourcepub fn finish(&mut self) -> HttpResponse<BoxBody>
pub fn finish(&mut self) -> HttpResponse<BoxBody>
Set an empty body and build the HttpResponse
.
HttpResponseBuilder
can not be used after this call.
sourcepub fn take(&mut self) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
pub fn take(&mut self) -> HttpResponseBuilderⓘNotable traits for HttpResponseBuilderimpl Future for HttpResponseBuilder type Output = Result<HttpResponse<BoxBody>, Error>;
This method construct new HttpResponseBuilder
Trait Implementations
sourceimpl From<HttpResponseBuilder> for Response<BoxBody>
impl From<HttpResponseBuilder> for Response<BoxBody>
sourcefn from(builder: HttpResponseBuilder) -> Response<BoxBody>
fn from(builder: HttpResponseBuilder) -> Response<BoxBody>
Converts to this type from the input type.
sourceimpl From<HttpResponseBuilder> for HttpResponse<BoxBody>
impl From<HttpResponseBuilder> for HttpResponse<BoxBody>
sourcefn from(builder: HttpResponseBuilder) -> HttpResponse<BoxBody>
fn from(builder: HttpResponseBuilder) -> HttpResponse<BoxBody>
Converts to this type from the input type.
sourceimpl Future for HttpResponseBuilder
impl Future for HttpResponseBuilder
type Output = Result<HttpResponse<BoxBody>, Error>
type Output = Result<HttpResponse<BoxBody>, Error>
The type of value produced on completion.
sourcefn poll(
self: Pin<&mut HttpResponseBuilder>,
&mut Context<'_>
) -> Poll<<HttpResponseBuilder as Future>::Output>
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
sourceimpl Responder for HttpResponseBuilder
impl Responder for HttpResponseBuilder
type Body = BoxBody
sourcefn respond_to(
self,
&HttpRequest
) -> HttpResponse<<HttpResponseBuilder as Responder>::Body>
fn respond_to(
self,
&HttpRequest
) -> HttpResponse<<HttpResponseBuilder as Responder>::Body>
Convert self to HttpResponse
.
sourcefn customize(self) -> CustomizeResponder<Self>
fn customize(self) -> CustomizeResponder<Self>
Wraps responder to allow alteration of its 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> FutureExt for T where
T: Future + ?Sized,
impl<T> FutureExt for T where
T: Future + ?Sized,
sourcefn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
Map this future’s output to a different type, returning a new future of the resulting type. Read more
sourcefn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
Map this future’s output to a different type, returning a new future of the resulting type. Read more
sourcefn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
Chain on a computation for when a future finished, passing the result of
the future to the provided closure f
. Read more
sourcefn 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
sourcefn 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
sourcefn into_stream(self) -> IntoStream<Self>
fn into_stream(self) -> IntoStream<Self>
Convert this future into a single element stream. Read more
sourcefn flatten(self) -> Flatten<Self> where
Self::Output: Future,
fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
Flatten the execution of this future when the output of this future is itself another future. Read more
sourcefn 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
sourcefn 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
sourcefn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
Do something with the output of a future before passing it on. Read more
sourcefn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
sourcefn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,
fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,
Wrap the future in a Box, pinning it. Read more
sourcefn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
Wrap the future in a Box, pinning it. Read more
sourcefn unit_error(self) -> UnitError<Self>
fn unit_error(self) -> UnitError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
sourcefn 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
sourcefn 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.
sourcefn 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
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<F> IntoFuture for F where
F: Future,
impl<F> IntoFuture for F where
F: Future,
type Output = <F as Future>::Output
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type IntoFuture = F
type IntoFuture = F
into_future
)Which kind of future are we turning this into?
sourcefn into_future(self) -> <F as IntoFuture>::IntoFuture
fn into_future(self) -> <F as IntoFuture>::IntoFuture
into_future
)Creates a future from a value.
sourceimpl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
sourcefn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,
fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,
Maps this future’s success value to a different value. Read more
sourcefn 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,
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,
Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more
sourcefn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Maps this future’s error value to a different value. Read more
sourcefn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more
sourcefn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
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
sourcefn 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
sourcefn 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
sourcefn 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
sourcefn 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
sourcefn 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,
sourcefn into_future(self) -> IntoFuture<Self>
fn into_future(self) -> IntoFuture<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more