Struct salvo_core::test::RequestBuilder

pub struct RequestBuilder { /* private fields */ }

Available on crate feature test only.

RequestBuilder is the main way of building requests.

You can create a RequestBuilder using the new or try_new method, but the recommended way or use one of the simpler constructors available in the crate root or on the Session struct, such as get, post, etc.

Implementations

impl RequestBuilder

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

where U: AsRef<str>,

Create a new RequestBuilder with the base URL and the given method.

Panics

Panics if the base url is invalid or if the method is CONNECT.

impl RequestBuilder

pub fn query<K, V>(self, key: K, value: V) -> Self

where K: AsRef<str>, V: ToString,

Associate a query string parameter to the given value.

The same key can be used multiple times.

pub fn queries<P, K, V>(self, pairs: P) -> Self

where P: IntoIterator, P::Item: Borrow<(K, V)>, K: AsRef<str>, V: ToString,

Associated a list of pairs to query parameters.

The same key can be used multiple times.

Example

TestClient::get("http://foo.bar").queries(&[("p1", "v1"), ("p2", "v2")]);

pub fn basic_auth( self, username: impl Display, password: Option<impl Display> ) -> Self

Enable HTTP basic authentication.

pub fn bearer_auth(self, token: impl Into<String>) -> Self

Enable HTTP bearer authentication.

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

Sets the body of this request.

pub fn text(self, body: impl Into<String>) -> Self

Sets the body of this request to be text.

If the Content-Type header is unset, it will be set to text/plain and the charset to UTF-8.

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

Sets the body of this request to be bytes.

If the Content-Type header is unset, it will be set to application/octet-stream.

pub fn json<T: Serialize>(self, value: &T) -> Self

Sets the body of this request to be the JSON representation of the given object.

If the Content-Type header is unset, it will be set to application/json and the charset to UTF-8.

pub fn raw_json(self, value: impl Into<String>) -> Self

Sets the body of this request to be the JSON representation of the given string.

If the Content-Type header is unset, it will be set to application/json and the charset to UTF-8.

pub fn form<T: Serialize>(self, value: &T) -> Self

Sets the body of this request to be the URL-encoded representation of the given object.

If the Content-Type header is unset, it will be set to application/x-www-form-urlencoded.

pub fn raw_form(self, value: impl Into<String>) -> Self

Sets the body of this request to be the URL-encoded representation of the given string.

If the Content-Type header is unset, it will be set to application/x-www-form-urlencoded.

pub fn add_header<N, V>(self, name: N, value: V, overwrite: bool) -> Self

where N: IntoHeaderName, V: TryInto<HeaderValue>,

Modify a header for this response.

When overwrite is set to true, If the header is already present, the value will be replaced. When overwrite is set to false, The new header is always appended to the request, even if the header already exists.

pub fn build(self) -> Request

Build final request.

pub fn build_hyper(self) -> Request<ReqBody>

Build hyper request.

pub async fn send(self, target: impl SendTarget + Send) -> Response

Send request to target, such as Router, Service, Handler.

Trait Implementations

impl Debug for RequestBuilder

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

Formats the value using the given formatter.