Struct pact_models::v4::sync_message::SynchronousMessage

pub struct SynchronousMessage {
    pub id: Option<String>,
    pub key: Option<String>,
    pub description: String,
    pub provider_states: Vec<ProviderState>,
    pub comments: HashMap<String, Value>,
    pub request: MessageContents,
    pub response: Vec<MessageContents>,
    pub pending: bool,
    pub plugin_config: HashMap<String, HashMap<String, Value>>,
    pub interaction_markup: InteractionMarkup,
    pub transport: Option<String>,
}

Synchronous interactions as a request message to a sequence of response messages

Fields

id: Option<String>

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

key: Option<String>

Unique key for this interaction

description: String

A description for the interaction. Must be unique within the Pact file

provider_states: Vec<ProviderState>

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

comments: HashMap<String, Value>

Annotations and comments associated with this interaction

request: MessageContents

Request message

response: Vec<MessageContents>

Response messages

pending: bool

If this interaction is pending. Pending interactions will never fail the build if they fail

plugin_config: HashMap<String, HashMap<String, Value>>

Configuration added by plugins

interaction_markup: InteractionMarkup

Text markup to use to render the interaction in a UI

transport: Option<String>

Transport mechanism used with this message

Implementations

impl SynchronousMessage

pub fn with_key(&self) -> SynchronousMessage

Creates a new version with a calculated key

pub fn from_json(json: &Value, index: usize) -> Result<SynchronousMessage>

Parse the JSON into a SynchronousMessages structure

Trait Implementations

impl Clone for SynchronousMessage

fn clone(&self) -> SynchronousMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SynchronousMessage

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

Formats the value using the given formatter.

impl Default for SynchronousMessage

fn default() -> Self

Returns the “default value” for a type.

impl Display for SynchronousMessage

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

Formats the value using the given formatter.

impl Hash for SynchronousMessage

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Interaction for SynchronousMessage

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 + RefUnwindSafe>>

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 is_v4_sync_message(&self) -> bool

If the interaction is a V4 synchronous request/response message

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 + RefUnwindSafe>

Clones this interaction and wraps it in a Box

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

Clones this interaction and wraps it in an Arc

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

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 pending(&self) -> bool

If this interaction is pending (V4 only)

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

impl PartialEq for SynchronousMessage

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl V4Interaction for SynchronousMessage

fn to_json(&self) -> Value

Convert the interaction to a JSON Value

fn to_super(&self) -> &(dyn Interaction + Send + Sync + RefUnwindSafe)

Convert the interaction to its super trait

fn to_super_mut(&mut self) -> &mut (dyn Interaction + Send + Sync)

Convert the interaction to its super trait

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

Key for this interaction

fn boxed_v4(&self) -> Box<dyn V4Interaction + Send + Sync + RefUnwindSafe>

Clones this interaction and wraps it in a box

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

Annotations and comments associated with this interaction

fn comments_mut(&mut self) -> &mut HashMap<String, Value>

Mutable access to the annotations and comments associated with this interaction

fn v4_type(&self) -> V4InteractionType

Type of this V4 interaction

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

Any configuration added to the interaction from a plugin

fn plugin_config_mut(&mut self) -> &mut HashMap<String, HashMap<String, Value>>

Any configuration added to the interaction from a plugin

fn interaction_markup(&self) -> InteractionMarkup

Markup added to the interaction to render in UIs

fn interaction_markup_mut(&mut self) -> &mut InteractionMarkup

Markup added to the interaction to render in UIs

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

Transport used with the interaction

fn set_transport(&mut self, transport: Option<String>)

Set the transport used with the interaction

fn with_unique_key( &self ) -> Box<dyn V4Interaction + Send + Sync + RefUnwindSafe>

Creates a new version with a calculated key

fn unique_key(&self) -> String

Returns the current key if set, otherwise calculates a new one

impl Eq for SynchronousMessage