Struct actix_web::dev::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) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn new(status: StatusCode) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Create response builder
pub fn status(&mut self, status: StatusCode) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn status(&mut self, status: StatusCode) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Set HTTP status code of this response.
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
V: IntoHeaderValue,
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<Error>,
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
V: IntoHeaderValue,
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<Error>,
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Append a header to existing headers.
use actix_http::{http, Request, Response};
fn index(req: Request) -> Response {
Response::Ok()
.header("X-TEST", "value")
.header(http::header::CONTENT_TYPE, "application/json")
.finish()
}
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
V: IntoHeaderValue,
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<Error>,
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
V: IntoHeaderValue,
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<Error>,
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Set a header.
use actix_http::{http, Request, Response};
fn index(req: Request) -> Response {
Response::Ok()
.set_header("X-TEST", "value")
.set_header(http::header::CONTENT_TYPE, "application/json")
.finish()
}
pub fn reason(&mut self, reason: &'static str) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn reason(&mut self, reason: &'static str) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Set the custom reason for the response.
pub fn keep_alive(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn keep_alive(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Set connection type to KeepAlive
pub fn upgrade<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
V: IntoHeaderValue,
pub fn upgrade<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
V: IntoHeaderValue,
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Set connection type to Upgrade
pub fn force_close(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn force_close(&mut self) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, 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 ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn no_chunking(&mut self, len: u64) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, 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 ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<Error>,
pub fn content_type<V>(&mut self, value: V) -> &mut ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
where
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<Error>,
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Set response content type
Set a cookie
use actix_http::{http, Request, Response};
fn index(req: Request) -> Response {
Response::Ok()
.cookie(
http::Cookie::build("name", "value")
.domain("www.rust-lang.org")
.path("/")
.secure(true)
.http_only(true)
.finish(),
)
.finish()
}
Remove cookie
use actix_http::{http, Request, Response, HttpMessage};
fn index(req: Request) -> Response {
let mut builder = Response::Ok();
if let Some(ref cookie) = req.cookie("name") {
builder.del_cookie(cookie);
}
builder.finish()
}
Responses extensions
Mutable reference to a the response’s extensions
Set a body and generate Response
.
ResponseBuilder
can not be used after this call.
Set a body and generate Response
.
ResponseBuilder
can not be used after this call.
Set a streaming body and generate Response
.
ResponseBuilder
can not be used after this call.
Set a json body and generate Response
ResponseBuilder
can not be used after this call.
Set a json body and generate Response
ResponseBuilder
can not be used after this call.
Set an empty body and generate Response
ResponseBuilder
can not be used after this call.
pub fn take(&mut self) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn take(&mut self) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
This method construct new ResponseBuilder
Trait Implementations
Get content encoding
Set content encoding
Convert ResponseHead
to a ResponseBuilder
pub fn from(head: &'a ResponseHead) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn from(head: &'a ResponseHead) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Performs the conversion.
Convert Response
to a ResponseBuilder
. Body get dropped.
pub fn from(res: Response<B>) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
pub fn from(res: Response<B>) -> ResponseBuilderⓘNotable traits for ResponseBuilderimpl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
impl Future for ResponseBuilder type Output = Result<Response<Body>, Error>;
Performs the conversion.
Convert ResponseBuilder to a Error
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
Convert itself to AsyncResult
or Error
.
Override a status code for a Responder. Read more
fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self> where
Self: Sized,
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
V: IntoHeaderValue,
fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self> where
Self: Sized,
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
V: IntoHeaderValue,
Add header to the Responder’s 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.
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
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more