Struct http::response::Builder

pub struct Builder { /* private fields */ }

An HTTP response builder

This type can be used to construct an instance of Response through a builder-like pattern.

Implementations

impl 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();

pub fn status<T>(&mut self, status: T) -> &mut Builder where
    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();

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();

pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Builder where
    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();

pub fn headers_ref(&self) -> Option<&HeaderMap<HeaderValue>>

Get header on this response builder. when builder has error returns None

Example

let mut res = Response::builder();
res.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" );

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" );

pub fn extension<T>(&mut self, extension: T) -> &mut 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"));

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();

Trait Implementations

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.