Struct pact_models::sync_interaction::RequestResponseInteraction

pub struct RequestResponseInteraction {
    pub id: Option<String>,
    pub description: String,
    pub provider_states: Vec<ProviderState>,
    pub request: Request,
    pub response: Response,
}

Struct that defines an interaction (request and response pair)

Fields

id: Option<String>

Interaction ID. This will only be set if the Pact file was fetched from a Pact Broker

description: String

Description of this interaction. This needs to be unique in the pact file.

provider_states: Vec<ProviderState>

Optional provider states for the interaction. See <https://docs.pact.io/getting_started/provider_states> for more info on provider states.

request: Request

Request of the interaction

response: Response

Response of the interaction

Implementations

impl RequestResponseInteraction

pub fn from_json(
    index: usize,
    pact_json: &Value,
    spec_version: &PactSpecification
) -> Result<RequestResponseInteraction>

Constructs an Interaction from the Value struct.

pub fn to_json(&self, spec_version: &PactSpecification) -> Value

Converts this interaction to a Value struct.

pub fn conflicts_with(&self, other: &dyn Interaction) -> Vec<PactConflict>

Returns list of conflicts if this interaction conflicts with the other interaction.

Two interactions conflict if they have the same description and provider state, but they request and responses are not equal

pub fn schema(_spec_version: PactSpecification) -> Value

Generate the JSON schema properties for the given Pact specification

Trait Implementations

impl Clone for RequestResponseInteraction

fn clone(&self) -> RequestResponseInteraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestResponseInteraction

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

Formats the value using the given formatter.

impl Default for RequestResponseInteraction

fn default() -> Self

Returns the “default value” for a type.

impl Display for RequestResponseInteraction

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

Formats the value using the given formatter.

impl Hash for RequestResponseInteraction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Interaction for RequestResponseInteraction

fn type_of(&self) -> String

The type of the interaction

fn is_request_response(&self) -> bool

If this is a request/response interaction

fn as_request_response(&self) -> Option<RequestResponseInteraction>

Returns the request/response interaction if it is one

fn is_message(&self) -> bool

If this is a message interaction

fn as_message(&self) -> Option<Message>

Returns the message interaction if it is one

fn id(&self) -> Option<String>

Interaction ID. This will only be set if the Pact file was fetched from a Pact Broker

fn description(&self) -> String

Description of this interaction. This needs to be unique in the pact file.

fn set_id(&mut self, id: Option<String>)

Set the Interaction ID

fn set_description(&mut self, description: &str)

Set the description of this interaction. This needs to be unique in the pact file.

fn provider_states(&self) -> Vec<ProviderState>

Optional provider states for the interaction. See <https://docs.pact.io/getting_started/provider_states> for more info on provider states.

fn provider_states_mut(&mut self) -> &mut Vec<ProviderState>

Mutable Optional provider states for the interaction. See <https://docs.pact.io/getting_started/provider_states> for more info on provider states.

fn contents(&self) -> OptionalBody

👎 Deprecated since 0.1.0:

Some interactions have multiple contents (like request/response), so it is impossible to know which to return for this method

Body of the response or message

fn contents_for_verification(&self) -> OptionalBody

The contents of the part to use for verification. For example, with HTTP interactions, this will be the response body

fn content_type(&self) -> Option<ContentType>

👎 Deprecated since 0.1.0:

Some interactions have multiple contents (like request/response), so it is impossible to know which to return for this method

Determine the content type of the interaction. If a Content-Type header or metadata value is present, the value of that value will be returned. Otherwise, the contents will be inspected.

fn is_v4(&self) -> bool

If this is a V4 interaction

fn as_v4(&self) -> Option<Box<dyn V4Interaction + Send + Sync>>

Returns the interaction in V4 format

fn as_v4_mut(&mut self) -> Option<&mut dyn V4Interaction>

Returns a mutable reference for the interaction. If the interaction is not a V4 format, will return None. The as_v4 method can convert to V4 format (via cloning the data).

fn as_v4_http(&self) -> Option<SynchronousHttp>

Returns the interaction in V4 format

fn as_v4_async_message(&self) -> Option<AsynchronousMessage>

Returns the interaction in V4 format

fn as_v4_sync_message(&self) -> Option<SynchronousMessage>

Returns the interaction in V4 format

fn as_v4_http_mut(&mut self) -> Option<&mut SynchronousHttp>

Returns the interaction in V4 format

fn as_v4_async_message_mut(&mut self) -> Option<&mut AsynchronousMessage>

Returns the interaction in V4 format

fn as_v4_sync_message_mut(&mut self) -> Option<&mut SynchronousMessage>

Returns the interaction in V4 format

fn boxed(&self) -> Box<dyn Interaction + Send + Sync>

Clones this interaction and wraps it in a Box

fn arced(&self) -> Arc<dyn Interaction + Send + Sync>

Clones this interaction and wraps it in an Arc

fn thread_safe(&self) -> Arc<Mutex<dyn Interaction + Send + Sync>>

Clones this interaction and wraps it in an Arc and Mutex

fn matching_rules(&self) -> Option<MatchingRules>

👎 Deprecated since 0.2.1:

Some interactions have multiple contents (like request/response), so it is impossible to know which to return for this method

Returns the matching rules associated with this interaction (if there are any)

fn is_v4_http(&self) -> bool

If the interaction is V4 HTTP

fn is_v4_async_message(&self) -> bool

If the interaction is a V4 message

fn is_v4_sync_message(&self) -> bool

If the interaction is a V4 synchronous request/response message

fn pending(&self) -> bool

If this interaction is pending (V4 only)

impl PactJsonVerifier for RequestResponseInteraction

fn verify_json(
    path: &str,
    pact_json: &Value,
    strict: bool,
    spec_version: PactSpecification
) -> Vec<PactFileVerificationResult>

Verify the JSON format. Will return an error if the list contains any Error result

impl PartialEq<RequestResponseInteraction> for RequestResponseInteraction

fn eq(&self, other: &RequestResponseInteraction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RequestResponseInteraction) -> bool

This method tests for !=.

impl Eq for RequestResponseInteraction

impl StructuralEq for RequestResponseInteraction

impl StructuralPartialEq for RequestResponseInteraction