Struct pact_consumer::builders::InteractionBuilder

pub struct InteractionBuilder {
    pub request: RequestBuilder,
    pub response: ResponseBuilder,
    pub interaction_type: String,
    /* private fields */
}

Builder for Interaction objects. Normally created via PactBuilder::interaction.

Fields

request: RequestBuilder

A builder for this interaction’s Request.

response: ResponseBuilder

A builder for this interaction’s Response.

interaction_type: String

The interaction type (as stored in the plugin catalogue)

Implementations

impl InteractionBuilder

pub fn new<D: Into<String>>(description: D, interaction_type: D) -> Self

Create a new interaction.

pub fn given<G: Into<String>>(&mut self, given: G) -> &mut Self

Specify a “provider state” for this interaction. This is normally use to set up database fixtures when using a pact to test a provider.

pub fn comment<G: Into<String>>(&mut self, comment: G) -> &mut Self

Adds a text comment to this interaction. This allows to specify just a bit more information about the interaction. It has no functional impact, but can be displayed in the broker HTML page, and potentially in the test output.

pub fn test_name<G: Into<String>>(&mut self, name: G) -> &mut Self

Sets the test name for this interaction. This allows to specify just a bit more information about the interaction. It has no functional impact, but can be displayed in the broker HTML page, and potentially in the test output.

pub fn build(&self) -> RequestResponseInteraction

The interaction we’ve built.

pub fn build_v4(&self) -> SynchronousHttp

The interaction we’ve built (in V4 format).

pub fn plugin_config(&self) -> HashMap<String, HashMap<String, Value>>

Any plugin configuration returned from plugins

Trait Implementations

impl Clone for InteractionBuilder

fn clone(&self) -> InteractionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionBuilder

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

Formats the value using the given formatter.