pub struct Builder { /* fields omitted */ }
An HTTP response builder
This type can be used to construct an instance of Response
through a
builder-like pattern.
Creates a new default instance of Builder
to construct either a
Head
or a Response
.
let response = response::Builder::new()
.status(200)
.body(())
.unwrap();
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
.
let response = Response::builder()
.status(200)
.body(())
.unwrap();
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
let response = Response::builder()
.version(Version::HTTP_2)
.body(())
.unwrap();
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
.
let response = Response::builder()
.header("Content-Type", "text/html")
.header("X-Custom-Foo", "bar")
.header("content-length", 0)
.body(())
.unwrap();
Adds an extension to this builder
let response = Response::builder()
.extension("My Extension")
.body(())
.unwrap();
assert_eq!(response.extensions().get::<&'static str>(),
Some(&"My Extension"));
pub fn body<T>(&mut self, body: T) -> Result<Response<T>> | [src] |
"Consumes" this builder, using the provided body
to return a
constructed Response
.
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.
This method will panic if the builder is reused. The body
function can
only be called once.
let response = Response::builder()
.body(())
.unwrap();
Returns the "default value" for a type. Read more
Formats the value using the given formatter. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static