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
sourceimpl 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>(self, status: T) -> Builder where
StatusCode: TryFrom<T>,
<StatusCode as TryFrom<T>>::Error: Into<Error>,
pub fn status<T>(self, status: T) -> Builder where
StatusCode: TryFrom<T>,
<StatusCode as TryFrom<T>>::Error: Into<Error>,
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(self, version: Version) -> Builder
pub fn version(self, version: Version) -> 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>(self, key: K, value: V) -> Builder where
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<Error>,
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<Error>,
pub fn header<K, V>(self, key: K, value: V) -> Builder where
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<Error>,
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<Error>,
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 headers_ref(&self) -> Option<&HeaderMap<HeaderValue>>
pub fn headers_ref(&self) -> Option<&HeaderMap<HeaderValue>>
Get header on this response builder.
When builder has error returns None.
Example
let res = Response::builder()
.header("Accept", "text/html")
.header("X-Custom-Foo", "bar");
let headers = res.headers_ref().unwrap();
assert_eq!( headers["Accept"], "text/html" );
assert_eq!( headers["X-Custom-Foo"], "bar" );
sourcepub fn headers_mut(&mut self) -> Option<&mut HeaderMap<HeaderValue>>
pub fn headers_mut(&mut self) -> Option<&mut HeaderMap<HeaderValue>>
Get header on this response builder. when builder has error returns None
Example
let mut res = Response::builder();
{
let headers = res.headers_mut().unwrap();
headers.insert("Accept", HeaderValue::from_static("text/html"));
headers.insert("X-Custom-Foo", HeaderValue::from_static("bar"));
}
let headers = res.headers_ref().unwrap();
assert_eq!( headers["Accept"], "text/html" );
assert_eq!( headers["X-Custom-Foo"], "bar" );
sourcepub fn extension<T>(self, extension: T) -> Builder where
T: Any + Send + Sync + 'static,
pub fn extension<T>(self, extension: T) -> Builder where
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 extensions_ref(&self) -> Option<&Extensions>
pub fn extensions_ref(&self) -> Option<&Extensions>
Get a reference to the extensions for this response builder.
If the builder has an error, this returns None
.
Example
let res = Response::builder().extension("My Extension").extension(5u32);
let extensions = res.extensions_ref().unwrap();
assert_eq!(extensions.get::<&'static str>(), Some(&"My Extension"));
assert_eq!(extensions.get::<u32>(), Some(&5u32));
sourcepub fn extensions_mut(&mut self) -> Option<&mut Extensions>
pub fn extensions_mut(&mut self) -> Option<&mut Extensions>
Get a mutable reference to the extensions for this response builder.
If the builder has an error, this returns None
.
Example
let mut res = Response::builder().extension("My Extension");
let mut extensions = res.extensions_mut().unwrap();
assert_eq!(extensions.get::<&'static str>(), Some(&"My Extension"));
extensions.insert(5u32);
assert_eq!(extensions.get::<u32>(), Some(&5u32));
sourcepub fn body<T>(self, body: T) -> Result<Response<T>>
pub fn body<T>(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.
Examples
let response = Response::builder()
.body(())
.unwrap();
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl !UnwindSafe for Builder
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