Struct actix_web::dev::BaseHttpResponseBuilder [−][src]
pub struct BaseHttpResponseBuilder { /* fields omitted */ }
Expand description
An HTTP response builder.
Used to construct an instance of Response
using a builder pattern. Response builders are often
created using Response::build
.
Examples
use actix_http::{Response, ResponseBuilder, body, http::StatusCode, http::header}; let mut res: Response<_> = Response::build(StatusCode::OK) .content_type(mime::APPLICATION_JSON) .insert_header((header::SERVER, "my-app/1.0")) .append_header((header::SET_COOKIE, "a=1")) .append_header((header::SET_COOKIE, "b=2")) .body("1234"); assert_eq!(res.status(), StatusCode::OK); assert!(res.headers().contains_key("server")); assert_eq!(res.headers().get_all("set-cookie").count(), 2); assert_eq!(body::to_bytes(res.into_body()).await.unwrap(), &b"1234"[..]);
Implementations
pub fn new(status: StatusCode) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn new(status: StatusCode) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Create response builder
Examples
use actix_http::{Response, ResponseBuilder, http::StatusCode}; let res: Response<_> = ResponseBuilder::default().finish(); assert_eq!(res.status(), StatusCode::OK);
pub fn status(&mut self, status: StatusCode) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn status(&mut self, status: StatusCode) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Set HTTP status code of this response.
Examples
use actix_http::{ResponseBuilder, http::StatusCode}; let res = ResponseBuilder::default().status(StatusCode::NOT_FOUND).finish(); assert_eq!(res.status(), StatusCode::NOT_FOUND);
pub fn insert_header<H>(&mut self, header: H) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
H: IntoHeaderPair,
pub fn insert_header<H>(&mut self, header: H) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
H: IntoHeaderPair,
Insert a header, replacing any that were set with an equivalent field name.
Examples
use actix_http::{ResponseBuilder, http::header}; let res = ResponseBuilder::default() .insert_header((header::CONTENT_TYPE, mime::APPLICATION_JSON)) .insert_header(("X-TEST", "value")) .finish(); assert!(res.headers().contains_key("content-type")); assert!(res.headers().contains_key("x-test"));
pub fn append_header<H>(&mut self, header: H) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
H: IntoHeaderPair,
pub fn append_header<H>(&mut self, header: H) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
H: IntoHeaderPair,
Append a header, keeping any that were set with an equivalent field name.
Examples
use actix_http::{ResponseBuilder, http::header}; let res = ResponseBuilder::default() .append_header((header::CONTENT_TYPE, mime::APPLICATION_JSON)) .append_header(("X-TEST", "value1")) .append_header(("X-TEST", "value2")) .finish(); assert_eq!(res.headers().get_all("content-type").count(), 1); assert_eq!(res.headers().get_all("x-test").count(), 2);
pub fn reason(&mut self, reason: &'static str) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn reason(&mut self, reason: &'static str) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Set the custom reason for the response.
pub fn keep_alive(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn keep_alive(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Set connection type to KeepAlive
pub fn upgrade<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
V: IntoHeaderValue,
pub fn upgrade<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
V: IntoHeaderValue,
Set connection type to Upgrade
pub fn force_close(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn force_close(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Force close connection, even if it is marked as keep-alive
pub fn no_chunking(&mut self, len: u64) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn no_chunking(&mut self, len: u64) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Disable chunked transfer encoding for HTTP/1.1 streaming responses.
pub fn content_type<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
V: IntoHeaderValue,
pub fn content_type<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
where
V: IntoHeaderValue,
Set response content type.
Responses extensions
Mutable reference to a the response’s extensions
Generate response with a wrapped body.
This ResponseBuilder
will be left in a useless state.
Generate response with a body.
This ResponseBuilder
will be left in a useless state.
Generate response with a streaming body.
This ResponseBuilder
will be left in a useless state.
Generate response with an empty body.
This ResponseBuilder
will be left in a useless state.
pub fn take(&mut self) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn take(&mut self) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Create an owned ResponseBuilder
, leaving the original in a useless state.
Trait Implementations
Get content encoding
Set content encoding Read more
pub fn default() -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn default() -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Returns the “default value” for a type. Read more
Convert ResponseHead
to a ResponseBuilder
pub fn from(head: &'a ResponseHead) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn from(head: &'a ResponseHead) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Performs the conversion.
Convert Response
to a ResponseBuilder
. Body get dropped.
pub fn from(res: Response<B>) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
pub fn from(res: Response<B>) -> ResponseBuilderⓘNotable traits for ResponseBuilder
impl Future for ResponseBuilder type Output = Result<Response<AnyBody>, Error>;
Performs the conversion.
Performs the conversion.
pub fn poll(
self: Pin<&mut ResponseBuilder>,
&mut Context<'_>
) -> Poll<<ResponseBuilder as Future>::Output>
pub fn poll(
self: Pin<&mut ResponseBuilder>,
&mut Context<'_>
) -> Poll<<ResponseBuilder 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
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘNotable traits for HttpResponse<Body>
impl Future for HttpResponse<Body> type Output = Result<Response<Body>, Error>;
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘNotable traits for HttpResponse<Body>
impl Future for HttpResponse<Body> type Output = Result<Response<Body>, Error>;
Convert self to HttpResponse
.
Override a status code for a Responder. Read more
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
Insert header to the final response. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ResponseBuilder
impl !Send for ResponseBuilder
impl !Sync for ResponseBuilder
impl Unpin for ResponseBuilder
impl !UnwindSafe for ResponseBuilder
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
Wrap this future in an Either
future, making it the left-hand variant
of that Either
. Read more
Wrap this future in an Either
future, making it the right-hand variant
of that Either
. Read more
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
Flatten the execution of this future when the successful result of this future is a stream. Read more
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
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
Turn this future into a future that yields ()
on completion and sends
its output to another future on a separate task. Read more
Wrap the future in a Box, pinning it. Read more
Wrap the future in a Box, pinning it. Read more
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>. Read more
A convenience for calling Future::poll
on Unpin
future types.
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
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
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
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
Do something with the success value of a future before passing it on. Read more
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,
pub fn vzip(self) -> V