Struct salvo_core::test::RequestBuilder

source · [−]

pub struct RequestBuilder { /* private fields */ }

Available on crate feature test only.

Expand description

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

source

impl RequestBuilder

source

pub fn new(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.

source

impl RequestBuilder

source

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.

source

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")]);

source

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

Enable HTTP basic authentication.

source

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

Enable HTTP bearer authentication.

source

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

Set the body of this request.

source

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

Set 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.

source

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

Set the body of this request to be bytes.

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

source

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

Set 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.

source

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

Set 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.

source

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

Set 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.

source

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

Set 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.

source

pub fn insert_header<H, V>(self, header: H, value: V) -> Self where
H: IntoHeaderName,
V: TryInto<HeaderValue>,

Modify a header for this request.

If the header is already present, the value will be replaced. If you wish to append a new header, use header_append.

source

pub fn append_header<H, V>(self, header: H, value: V) -> Self where
H: IntoHeaderName,
V: TryInto<HeaderValue>,

Append a new header to this request.

The new header is always appended to the request, even if the header already exists.

source

pub fn build(self) -> Request

Build final request.

source

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

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

Trait Implementations

source

impl Debug for RequestBuilder

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for RequestBuilder

impl Send for RequestBuilder

impl Sync for RequestBuilder

impl Unpin for RequestBuilder

impl !UnwindSafe for RequestBuilder

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T where
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T where
T: 'a,

fn implicit(
 self,
 class: Class,
 constructed: bool,
 tag: u32
) -> TaggedParser<'a, Implicit, Self, E>

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct salvo_core::test::RequestBuilder

Implementations

impl RequestBuilder

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

impl RequestBuilder

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

pub fn queries<P, K, V>(self, pairs: P) -> Self where P: IntoIterator, P::Item: Borrow<(K, V)>, K: AsRef<str>, V: ToString,

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

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

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

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

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

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

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

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

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

pub fn insert_header<H, V>(self, header: H, value: V) -> Self where H: IntoHeaderName, V: TryInto<HeaderValue>,

pub fn append_header<H, V>(self, header: H, value: V) -> Self where H: IntoHeaderName, V: TryInto<HeaderValue>,

pub fn build(self) -> Request

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

Trait Implementations

impl Debug for RequestBuilder

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

Auto Trait Implementations

impl !RefUnwindSafe for RequestBuilder

impl Send for RequestBuilder

impl Sync for RequestBuilder

impl Unpin for RequestBuilder

impl !UnwindSafe for RequestBuilder

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<'a, T, E> AsTaggedExplicit<'a, E> for T where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

pub fn queries<P, K, V>(self, pairs: P) -> Self where
P: IntoIterator,
P::Item: Borrow<(K, V)>,
K: AsRef<str>,
V: ToString,

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

pub fn insert_header<H, V>(self, header: H, value: V) -> Self where
H: IntoHeaderName,
V: TryInto<HeaderValue>,

pub fn append_header<H, V>(self, header: H, value: V) -> Self where
H: IntoHeaderName,
V: TryInto<HeaderValue>,

impl<T> Any for T where
T: 'static + ?Sized,

impl<'a, T, E> AsTaggedExplicit<'a, E> for T where
T: 'a,

impl<'a, T, E> AsTaggedImplicit<'a, E> for T where
T: 'a,

fn implicit(
self,
class: Class,
constructed: bool,
tag: u32
) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,