Request

grillon::request

Struct Request 

Source 
pub struct Request<'c> {
    pub method: Method,
    pub url: Url,
    pub headers: Result<HeaderMap>,
    pub payload: Option<Body>,
    pub client: &'c Client,
    pub log_settings: &'c LogSettings,
    pub basic_auth: Option<BasicAuth>,
    pub bearer_auth: Option<BearerToken>,
}
Expand description

Represents an outgoing http request.

Can be executed with Request::assert().

Fields§

§method: Method

The http request method.

§url: Url

The http request url.

§headers: Result<HeaderMap>

The http request headers.

§payload: Option<Body>

The http request payload.

§client: &'c Client

The client used for this outgoing request.

§log_settings: &'c LogSettings

The log settings that will be used to output test results when asserting the http response.

§basic_auth: Option<BasicAuth>

Basic authenthication information.

§bearer_auth: Option<BearerToken>

Bearer authentication token.

Implementations§

Source§

impl Request<'_>

Source

pub fn headers<H: RequestHeaders>(self, headers: H) -> Self

Sets the headers to the Request.

§Example
Grillon::new("https://jsonplaceholder.typicode.com")?
    .delete("users/1")
    .headers(vec![(
        header::CONTENT_TYPE,
        header::HeaderValue::from_static("application/json"),
    )]);
Source

pub fn payload(self, json: Value) -> Self

Sets the body to the Request.

§Example
Grillon::new("https://jsonplaceholder.typicode.com")?
    .post("users")
    .payload(json!({
        "name": "Isaac",
     }));
Source

pub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> Self
where U: AsRef<str> + Display, P: AsRef<str> + Display,

Enable HTTP basic authentication.

Basic authentication will automatically be considered as a sensitive header.

Source

pub fn bearer_auth<T>(self, token: T) -> Self
where T: AsRef<str> + Display,

Enable HTTP bearer authentication.

Bearer authentication will automatically be considered as a sensitive header.

Source

pub async fn assert(self) -> Assert

Sends the http request and creates an instance of Assert with the http response.

This function consumes the Request.

§Example
Grillon::new("https://jsonplaceholder.typicode.com")?
    .get("users")
    .assert()
    .await;

Auto Trait Implementations§

§

impl<'c> !Freeze for Request<'c>

§

impl<'c> !RefUnwindSafe for Request<'c>

§

impl<'c> Send for Request<'c>

§

impl<'c> Sync for Request<'c>

§

impl<'c> Unpin for Request<'c>

§

impl<'c> !UnwindSafe for Request<'c>

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
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,