Struct Builder

pub struct Builder { /* private fields */ }

An HTTP request builder

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

Implementations

impl Builder

pub fn new<T>(url: T) -> Builder

where Url: HttpTryFrom<T>,

Creates a new default instance of Builder to construct either a Head or a Request.

Examples

let req = request::Builder::new("http://example.org/")
    .method("POST")
    .body(())
    .unwrap();

pub fn whole_server(&mut self) -> &mut Builder

Send the request to the whole server, as opposed to a specific named resource.

Only valid in combination with an OPTIONS request and an empty path.

pub fn method<T>(&mut self, method: T) -> &mut Builder

where Method: HttpTryFrom<T>,

Set the HTTP method for this request.

This function will configure the HTTP method of the Request that will be returned from Builder::build.

By default this is GET.

Examples

let req = Request::builder("http://example.org")
    .method("POST")
    .body(())
    .unwrap();

pub fn version(&mut self, version: Version) -> &mut Builder

Set the HTTP version for this request.

This function will configure the HTTP version of the Request that will be returned from Builder::build.

By default this is HTTP/1.1

Examples

let req = Request::builder("http://example.org")
    .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 request 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 req = Request::builder("http://example.org")
    .header("Accept", "text/html")
    .header("X-Custom-Foo", "bar")
    .body(())
    .unwrap();

pub fn extension<T>(&mut self, extension: T) -> &mut Builder

where T: Any + Send + Sync + 'static,

Adds an extension to this builder

Examples

let req = Request::builder("http://example.org")
    .extension("My Extension")
    .body(())
    .unwrap();

assert_eq!(req.extensions().get::<&'static str>(),
           Some(&"My Extension"));

pub fn body<T>(&mut self, body: T) -> Result<Request<T>>

“Consumes” this builder, using the provided body to return a constructed Request.

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 request = Request::builder("http://example.org")
    .body(())
    .unwrap();

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.