pub struct Builder { /* 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§
source§impl Builder
impl Builder
sourcepub fn new() -> Builder
pub fn new() -> Builder
Creates a new default instance of Builder
to construct either a
Head
or a Response
.
Examples
let response = response::Builder::new()
.status(200)
.body(())
.unwrap();
sourcepub fn status<T>(&mut self, status: T) -> &mut Builderwhere
StatusCode: HttpTryFrom<T>,
pub fn status<T>(&mut self, status: T) -> &mut Builderwhere
StatusCode: HttpTryFrom<T>,
Set the HTTP status for this response.
This function will configure the HTTP status code of the Response
that
will be returned from Builder::build
.
By default this is 200
.
Examples
let response = Response::builder()
.status(200)
.body(())
.unwrap();
sourcepub fn version(&mut self, version: Version) -> &mut Builder
pub fn version(&mut self, version: Version) -> &mut Builder
Set the HTTP version for this response.
This function will configure the HTTP version of the Response
that
will be returned from Builder::build
.
By default this is HTTP/1.1
Examples
let response = Response::builder()
.version(Version::HTTP_2)
.body(())
.unwrap();
sourcepub fn header<K, V>(&mut self, key: K, value: V) -> &mut Builderwhere
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Builderwhere
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
Appends a header to this response builder.
This function will append the provided key/value as a header to the
internal HeaderMap
being constructed. Essentially this is equivalent
to calling HeaderMap::append
.
Examples
let response = Response::builder()
.header("Content-Type", "text/html")
.header("X-Custom-Foo", "bar")
.header("content-length", 0)
.body(())
.unwrap();
sourcepub fn extension<T>(&mut self, extension: T) -> &mut Builderwhere
T: Any + Send + Sync + 'static,
pub fn extension<T>(&mut self, extension: T) -> &mut Builderwhere
T: Any + Send + Sync + 'static,
Adds an extension to this builder
Examples
let response = Response::builder()
.extension("My Extension")
.body(())
.unwrap();
assert_eq!(response.extensions().get::<&'static str>(),
Some(&"My Extension"));
sourcepub fn body<T>(&mut self, body: T) -> Result<Response<T>>
pub fn body<T>(&mut self, body: T) -> Result<Response<T>>
“Consumes” this builder, using the provided body
to return a
constructed Response
.
Errors
This function may return an error if any previously configured argument
failed to parse or get converted to the internal representation. For
example if an invalid head
was specified via header("Foo", "Bar\r\n")
the error will be returned when this function is called
rather than when header
was called.
Panics
This method will panic if the builder is reused. The body
function can
only be called once.
Examples
let response = Response::builder()
.body(())
.unwrap();