[][src]Struct http::request::Builder

pub struct Builder { /* fields omitted */ }

An HTTP request builder

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

Methods

impl Builder
[src]

Creates a new default instance of Builder to construct a Request.

Examples


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

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()
    .method("POST")
    .body(())
    .unwrap();

Set the URI for this request.

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

By default this is /.

Examples


let req = Request::builder()
    .uri("https://www.rust-lang.org/")
    .body(())
    .unwrap();

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()
    .version(Version::HTTP_2)
    .body(())
    .unwrap();

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()
    .header("Accept", "text/html")
    .header("X-Custom-Foo", "bar")
    .body(())
    .unwrap();

Adds an extension to this builder

Examples


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

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

"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()
    .body(())
    .unwrap();

Trait Implementations

impl Default for Builder
[src]

impl Debug for Builder
[src]

Auto Trait Implementations

impl Send for Builder

impl Sync for Builder

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]