Struct pact_consumer::builders::RequestBuilder

pub struct RequestBuilder { /* private fields */ }

Builder for Request objects. Normally created via PactBuilder.

Implementations

impl RequestBuilder

pub fn method<M: Into<String>>(&mut self, method: M) -> &mut Self

Specify the request method. Defaults to "GET".

use pact_consumer::builders::RequestBuilder;
use pact_consumer::prelude::*;

let request = RequestBuilder::default().method("POST").build();
assert_eq!(request.method, "POST");

pub fn get(&mut self) -> &mut Self

Set the HTTP method to GET. This is the default, so we don’t actually care.

pub fn post(&mut self) -> &mut Self

Set the HTTP method to POST.

pub fn put(&mut self) -> &mut Self

Set the HTTP method to PUT.

pub fn delete(&mut self) -> &mut Self

Set the HTTP method to DELETE.

pub fn path<P: Into<StringPattern>>(&mut self, path: P) -> &mut Self

Specify the request path. Defaults to "/".

pub fn path_from_provider_state<E, P: Into<StringPattern>>(
    &mut self,
    expression: E,
    path: P
) -> &mut Self where
    E: Into<String>, 

Specify the request path with generators. Defaults to "/".

pub fn query_param<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: Into<String>,
    V: Into<StringPattern>, 

Specify a query parameter. You may pass either a single value or a list of values to represent a repeated parameter.

use pact_consumer::*;
use pact_consumer::builders::RequestBuilder;
use regex::Regex;

RequestBuilder::default()
    .query_param("simple", "value")
    .query_param("pattern", term!("^[0-9]+$", "123"));

To pass multiple parameters with the same name, call query_param more than once with the same key.

pub fn build(&self) -> Request

Build the specified Request object.

pub fn build_v4(&self) -> HttpRequest

Build the specified Request object in V4 format.

pub async fn contents(
    &mut self,
    content_type: ContentType,
    definition: Value
) -> &mut Self

Set the request body using the JSON data. If the body is being supplied by a plugin, this is what is sent to the plugin to setup the body.

Trait Implementations

impl Clone for RequestBuilder

fn clone(&self) -> RequestBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestBuilder

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

Formats the value using the given formatter.

impl Default for RequestBuilder

fn default() -> Self

Returns the “default value” for a type.

impl HttpPartBuilder for RequestBuilder

fn header<N, V>(&mut self, name: N, value: V) -> &mut Self where
    N: Into<String>,
    V: Into<StringPattern>, 

Specify a header pattern.

fn header_from_provider_state<N, E, V>(
    &mut self,
    name: N,
    expression: E,
    value: V
) -> &mut Self where
    N: Into<String>,
    E: Into<String>,
    V: Into<StringPattern>, 

Specify a header pattern and a generator from provider state.

fn content_type<CT>(&mut self, content_type: CT) -> &mut Self where
    CT: Into<StringPattern>, 

Set the Content-Type header.

fn html(&mut self) -> &mut Self

Set the Content-Type header to text/html.

fn json_utf8(&mut self) -> &mut Self

Set the Content-Type header to application/json; charset=utf-8, with enough flexibility to cover common variations.

fn body<B: Into<String>>(&mut self, body: B) -> &mut Self

Specify a body literal. This does not allow using patterns.

fn body2<B: Into<String>>(&mut self, body: B, content_type: B) -> &mut Self

Specify a body literal with content type. This does not allow using patterns.

fn json_body<B: Into<JsonPattern>>(&mut self, body: B) -> &mut Self

Specify the body as JsonPattern, possibly including special matching rules.