Struct Request

Source

pub struct Request {
    pub method: Method,
    pub url: Url,
    pub headers: Headers,
    pub body: Option<Vec<u8>>,
}

Fields§

§method: Method§url: Url§headers: Headers§body: Option<Vec<u8>>

Implementations§

Source §

impl Request

Source

pub fn new(method: Method, url: Url) -> Self

Construct a new request to the given url using the given method. Note that the request is not made until send() is called.

Source

pub fn send(self) -> Result<Response, ViaductError>

Source

pub fn get(url: Url) -> Self

Alias for Request::new(Method::Get, url), for convenience.

Source

pub fn patch(url: Url) -> Self

Alias for Request::new(Method::Patch, url), for convenience.

Source

pub fn post(url: Url) -> Self

Alias for Request::new(Method::Post, url), for convenience.

Source

pub fn put(url: Url) -> Self

Alias for Request::new(Method::Put, url), for convenience.

Source

pub fn delete(url: Url) -> Self

Alias for Request::new(Method::Delete, url), for convenience.

Source

pub fn query(self, pairs: &[(&str, &str)]) -> Self

Append the provided query parameters to the URL

§Example

let some_url = url::Url::parse("https://www.example.com/xyz").unwrap();

let req = Request::post(some_url).query(&[("a", "1234"), ("b", "qwerty")]);
assert_eq!(req.url.as_str(), "https://www.example.com/xyz?a=1234&b=qwerty");

// This appends to the query query instead of replacing `a`.
let req = req.query(&[("a", "5678")]);
assert_eq!(req.url.as_str(), "https://www.example.com/xyz?a=1234&b=qwerty&a=5678");

Source

pub fn set_query<'a, Q: Into<Option<&'a str>>>(self, query: Q) -> Self

Set the query string of the URL. Note that req.set_query(None) will clear the query.

See also Request::query which appends a slice of query pairs, which is typically more ergonomic when usable.

§Example

let some_url = url::Url::parse("https://www.example.com/xyz").unwrap();

let req = Request::post(some_url).set_query("a=b&c=d");
assert_eq!(req.url.as_str(), "https://www.example.com/xyz?a=b&c=d");

let req = req.set_query(None);
assert_eq!(req.url.as_str(), "https://www.example.com/xyz");

Source

pub fn headers(self, to_add: I) -> Self
where I: IntoIterator<Item = Header>,

Add all the provided headers to the list of headers to send with this request.

Add the provided header to the list of headers to send with this request.

This returns Err if val contains characters that may not appear in the body of a header.

§Example

Request::post(some_url)
    .header(header_names::CONTENT_TYPE, "application/json")?
    .header("My-Header", "Some special value")?;
// ...

Source

pub fn body(self, body: impl Into<Vec<u8>>) -> Self

Set this request’s body.

Source

pub fn json<T: ?Sized + Serialize>(self, val: &T) -> Self

Set body to the result of serializing val, and, unless it has already been set, set the Content-Type header to “application/json”.

Note: This panics if serde_json::to_vec fails. This can only happen in a couple cases:

Trying to serialize a map with non-string keys.
We wrote a custom serializer that fails.

Neither of these are things we do. If they happen, it seems better for this to fail hard with an easy to track down panic, than for e.g. sync to fail with a JSON parse error (which we’d probably attribute to corrupt data on the server, or something).