[−][src]Struct http::request::Builder
An HTTP request builder
This type can be used to construct an instance or Request
through a builder-like pattern.
Methods
impl Builder
[src]
pub fn new() -> Builder
[src]
Creates a new default instance of Builder
to construct a Request
.
Examples
let req = request::Builder::new() .method("POST") .body(()) .unwrap();
pub fn method<T>(&mut self, method: T) -> &mut Builder where
Method: HttpTryFrom<T>,
[src]
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();
pub fn method_ref(&self) -> Option<&Method>
[src]
Get the HTTP Method for this request.
By default this is GET
.
if builder has error, returns None.
Examples
let mut req = Request::builder(); assert_eq!(req.method_ref(),Some(&Method::GET)); req.method("POST"); assert_eq!(req.method_ref(),Some(&Method::POST)); req.method("DELETE"); assert_eq!(req.method_ref(),Some(&Method::DELETE));
pub fn uri<T>(&mut self, uri: T) -> &mut Builder where
Uri: HttpTryFrom<T>,
[src]
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();
pub fn uri_ref(&self) -> Option<&Uri>
[src]
Get the URI for this request
By default this is /
Examples
let mut req = Request::builder(); assert_eq!(req.uri_ref().unwrap().to_string(), "/" ); req.uri("https://www.rust-lang.org/"); assert_eq!(req.uri_ref().unwrap().to_string(), "https://www.rust-lang.org/" );
pub fn version(&mut self, version: Version) -> &mut Builder
[src]
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();
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Builder where
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
[src]
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();
pub fn headers_ref(&self) -> Option<&HeaderMap<HeaderValue>>
[src]
Get header on this request builder. when builder has error returns None
Example
let mut req = Request::builder(); req.header("Accept", "text/html") .header("X-Custom-Foo", "bar"); let headers = req.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>>
[src]
Get header on this request builder. when builder has error returns None
Example
let mut req = Request::builder(); { let headers = req.headers_mut().unwrap(); headers.insert("Accept", HeaderValue::from_static("text/html")); headers.insert("X-Custom-Foo", HeaderValue::from_static("bar")); } let headers = req.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,
[src]
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"));
pub fn body<T>(&mut self, body: T) -> Result<Request<T>>
[src]
"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
Auto Trait Implementations
impl Send for Builder
impl Unpin for Builder
impl Sync for Builder
impl !UnwindSafe for Builder
impl !RefUnwindSafe for Builder
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,