Struct pact_consumer::builders::SyncMessageInteractionBuilder

pub struct SyncMessageInteractionBuilder { /* private fields */ }

Synchronous message interaction builder. Normally created via PactBuilder::sync_message_interaction.

Implementations

impl SyncMessageInteractionBuilder

pub fn new<D: Into<String>>(description: D) -> SyncMessageInteractionBuilder

Create a new message interaction builder

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) -> SynchronousMessage

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

pub async fn contents_from(&mut self, contents: Value) -> &mut Self

Configure the interaction contents from a map

pub fn plugin_config(&self) -> Option<PluginData>

Any global plugin config required to add to the Pact

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

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

use pact_consumer::prelude::*;
use pact_consumer::*;
use pact_consumer::builders::SyncMessageInteractionBuilder;

SyncMessageInteractionBuilder::new("hello message").request_json_body(json_pattern!({
    "message": like!("Hello"),
}));

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

Specify the body as JsonPattern, possibly including special matching rules. You can call this method multiple times, each will add a new response message to the interaction.

use pact_consumer::prelude::*;
use pact_consumer::*;
use pact_consumer::builders::SyncMessageInteractionBuilder;

SyncMessageInteractionBuilder::new("hello message").response_json_body(json_pattern!({
    "message": like!("Hello"),
}));

Trait Implementations

impl Clone for SyncMessageInteractionBuilder

fn clone(&self) -> SyncMessageInteractionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncMessageInteractionBuilder

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

Formats the value using the given formatter.