pub struct Builder { /* private fields */ }
Expand description
An HTTP request builder
This type can be used to construct an instance or Request
through a builder-like pattern.
Implementations§
source§impl Builder
impl Builder
sourcepub fn new() -> Builder
pub fn new() -> Builder
Creates a new default instance of Builder
to construct a Request
.
Examples
let req = request::Builder::new()
.method("POST")
.body(())
.unwrap();
sourcepub fn method<T>(&mut self, method: T) -> &mut Builderwhere
Method: HttpTryFrom<T>,
pub fn method<T>(&mut self, method: T) -> &mut Builderwhere
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()
.method("POST")
.body(())
.unwrap();
sourcepub fn uri<T>(&mut self, uri: T) -> &mut Builderwhere
Uri: HttpTryFrom<T>,
pub fn uri<T>(&mut self, uri: T) -> &mut Builderwhere
Uri: HttpTryFrom<T>,
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();
sourcepub fn version(&mut self, version: Version) -> &mut Builder
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()
.version(Version::HTTP_2)
.body(())
.unwrap();
sourcepub fn header<K, V>(&mut self, key: K, value: V) -> &mut Builderwhere
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Builderwhere
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()
.header("Accept", "text/html")
.header("X-Custom-Foo", "bar")
.body(())
.unwrap();
sourcepub fn extension<T>(&mut self, extension: T) -> &mut Builderwhere
T: Any + Send + Sync + 'static,
pub fn extension<T>(&mut self, extension: T) -> &mut Builderwhere
T: Any + Send + Sync + 'static,
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"));
sourcepub fn body<T>(&mut self, body: T) -> Result<Request<T>>
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()
.body(())
.unwrap();