Struct goose::goose::GooseRequestBuilder

pub struct GooseRequestBuilder<'a> { /* fields omitted */ }

Used to build a GooseRequest object, necessary to make a request with Goose.

It’s only necessary to build manually if the GooseUser::get, GooseUser::get_named, GooseUser::post, GooseUser::post_form, GooseUser::post_json, GooseUser::head and GooseUser::delete helpers don’t provide you with enough flexibility.

Example

use goose::prelude::*;

let mut a_task = task!(task_function);

// A simple task that loads a relative path.
async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
    // Manually create a GooseRequestBuilder object.
    let goose_request = GooseRequest::builder()
        // Set a relative path to request.
        .path("about")
        // Name the request in the metircs.
        .name("About page")
        // Build the GooseRequest object.
        .build();

    // Make the configured request.
    let _goose = user.request(goose_request).await?;

    Ok(())
}

Implementations

impl<'a> GooseRequestBuilder<'a>

pub fn path(self, path: impl Into<&'a str>) -> Self

Set the path to request.

Typically is a relative path allowing Goose to append a configurable base_url.

Defaults to "" (the main index).

Example

This can be implemented in a simpler way using the GooseUser::get helper function.

use goose::prelude::*;

let mut a_task = task!(task_function);

// A simple task that loads a relative path.
async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
    // Manually create a GooseRequestBuilder object.
    let goose_request = GooseRequest::builder()
        // Set a relative path to request.
        .path("a/relative/path")
        // Build the GooseRequest object.
        .build();

    // Make the configured request.
    let _goose = user.request(goose_request).await?;

    Ok(())
}

pub fn method(self, method: GooseMethod) -> Self

Set the method of the request.

Must be set to a GooseMethod.

Defaults to GooseMethod::Get.

Example

use goose::prelude::*;

let mut a_task = task!(task_function);

// Make a DELETE request.
async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
    // Manually create a GooseRequestBuilder object.
    let goose_request = GooseRequest::builder()
        // Set a relative path to request.
        .path("path/to/delete")
        // Set the method to DELETE.
        .method(GooseMethod::Delete)
        // Build the GooseRequest object.
        .build();

    // Make the configured DELETE request.
    let _goose = user.request(goose_request).await?;

    Ok(())
}

pub fn name(self, name: impl Into<&'a str>) -> Self

Set a name for the request, affecting how it shows up in metrics.

Must be set to a GooseMethod.

Defaults to GooseMethod::Get.

Example

use goose::prelude::*;

let mut a_task = task!(task_function);

// Make a named request.
async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
    // Manually create a GooseRequestBuilder object.
    let goose_request = GooseRequest::builder()
        // Set a relative path to request.
        .path("path/to/request")
        // Name the request in the metrics.
        .name("custom name")
        // Build the GooseRequest object.
        .build();

    // Make the configured request.
    let _goose = user.request(goose_request).await?;

    Ok(())
}

pub fn expect_status_code(self, status_code: u16) -> Self

Manually configure the expected HTTP response status code.

Defaults to reqwest::StatusCode::is_success.

Example

Intentionally request a 404 page, and do not trigger an error.

use goose::prelude::*;

let mut a_task = task!(task_function);

// Make a named request.
async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
    // Manually create a GooseRequestBuilder object.
    let goose_request = GooseRequest::builder()
        // Set a relative path to request.
        .path("no/such/path")
        // Tell Goose to expect a 404 HTTP response status code.
        .expect_status_code(404)
        // Build the GooseRequest object.
        .build();

    // Make the configured request.
    let _goose = user.request(goose_request).await?;

    Ok(())
}

pub fn set_request_builder(self, request_builder: RequestBuilder) -> Self

Manually create the reqwest::RequestBuilder used to make a request.

Example

Manually create a RequestBuilder in order to set a timeout.

use goose::prelude::*;

let mut a_task = task!(task_function);

async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
    use std::time::Duration;

    // Manually interact with the Reqwest RequestBuilder object.
    let request_builder = user.get_request_builder(&GooseMethod::Get, "no/such/path")?
        // Configure the request to timeout if it takes longer than 500 milliseconds.
        .timeout(Duration::from_millis(500));

    // Manually build a GooseRequest in order to set our custom RequestBuilder.
    let goose_request = GooseRequest::builder()
        // Manually add our custom RequestBuilder object.
        .set_request_builder(request_builder)
        // Turn the GooseRequestBuilder object into a GooseRequest.
        .build();

    // Finally make the actual request with our custom GooseRequest object.
    let _goose = user.request(goose_request).await?;

    Ok(())
}

pub fn build(self) -> GooseRequest<'a>

Build the GooseRequest object which is then passed to GooseUser::request.

Example

use goose::prelude::*;

// Build the default "GET /".
let goose_request = GooseRequest::builder().build();