Struct pact_models::v4::sync_message::SynchronousMessage
source · [−]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>,
}
Expand description
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
sourceimpl SynchronousMessage
impl SynchronousMessage
sourcepub fn with_key(&self) -> SynchronousMessage
pub fn with_key(&self) -> SynchronousMessage
Creates a new version with a calculated key
Trait Implementations
sourceimpl Clone for SynchronousMessage
impl Clone for SynchronousMessage
sourcefn clone(&self) -> SynchronousMessage
fn clone(&self) -> SynchronousMessage
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SynchronousMessage
impl Debug for SynchronousMessage
sourceimpl Default for SynchronousMessage
impl Default for SynchronousMessage
sourceimpl Display for SynchronousMessage
impl Display for SynchronousMessage
sourceimpl Hash for SynchronousMessage
impl Hash for SynchronousMessage
sourceimpl Interaction for SynchronousMessage
impl Interaction for SynchronousMessage
sourcefn is_request_response(&self) -> bool
fn is_request_response(&self) -> bool
If this is a request/response interaction
sourcefn as_request_response(&self) -> Option<RequestResponseInteraction>
fn as_request_response(&self) -> Option<RequestResponseInteraction>
Returns the request/response interaction if it is one
sourcefn is_message(&self) -> bool
fn is_message(&self) -> bool
If this is a message interaction
sourcefn as_message(&self) -> Option<Message>
fn as_message(&self) -> Option<Message>
Returns the message interaction if it is one
sourcefn id(&self) -> Option<String>
fn id(&self) -> Option<String>
Interaction ID. This will only be set if the Pact file was fetched from a Pact Broker
sourcefn description(&self) -> String
fn description(&self) -> String
Description of this interaction. This needs to be unique in the pact file.
sourcefn set_description(&mut self, description: &str)
fn set_description(&mut self, description: &str)
Set the description of this interaction. This needs to be unique in the pact file.
sourcefn provider_states(&self) -> Vec<ProviderState>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn provider_states(&self) -> Vec<ProviderState>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Optional provider states for the interaction.
See <https://docs.pact.io/getting_started/provider_states>
for more info on provider states. Read more
sourcefn provider_states_mut(&mut self) -> &mut Vec<ProviderState>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn provider_states_mut(&mut self) -> &mut Vec<ProviderState>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Mutable Optional provider states for the interaction.
See <https://docs.pact.io/getting_started/provider_states>
for more info on provider states. Read more
sourcefn contents(&self) -> OptionalBody
fn contents(&self) -> OptionalBody
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
sourcefn contents_for_verification(&self) -> OptionalBody
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 Read more
sourcefn content_type(&self) -> Option<ContentType>
fn content_type(&self) -> Option<ContentType>
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. Read more
sourcefn as_v4(&self) -> Option<Box<dyn V4Interaction + Send + Sync>>
fn as_v4(&self) -> Option<Box<dyn V4Interaction + Send + Sync>>
Returns the interaction in V4 format
sourcefn as_v4_mut(&mut self) -> Option<&mut dyn V4Interaction>
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). Read more
sourcefn as_v4_http(&self) -> Option<SynchronousHttp>
fn as_v4_http(&self) -> Option<SynchronousHttp>
Returns the interaction in V4 format
sourcefn as_v4_async_message(&self) -> Option<AsynchronousMessage>
fn as_v4_async_message(&self) -> Option<AsynchronousMessage>
Returns the interaction in V4 format
sourcefn as_v4_sync_message(&self) -> Option<SynchronousMessage>
fn as_v4_sync_message(&self) -> Option<SynchronousMessage>
Returns the interaction in V4 format
sourcefn as_v4_http_mut(&mut self) -> Option<&mut SynchronousHttp>
fn as_v4_http_mut(&mut self) -> Option<&mut SynchronousHttp>
Returns the interaction in V4 format
sourcefn is_v4_sync_message(&self) -> bool
fn is_v4_sync_message(&self) -> bool
If the interaction is a V4 synchronous request/response message
sourcefn as_v4_async_message_mut(&mut self) -> Option<&mut AsynchronousMessage>
fn as_v4_async_message_mut(&mut self) -> Option<&mut AsynchronousMessage>
Returns the interaction in V4 format
sourcefn as_v4_sync_message_mut(&mut self) -> Option<&mut SynchronousMessage>
fn as_v4_sync_message_mut(&mut self) -> Option<&mut SynchronousMessage>
Returns the interaction in V4 format
sourcefn boxed(&self) -> Box<dyn Interaction + Send + Sync>
fn boxed(&self) -> Box<dyn Interaction + Send + Sync>
Clones this interaction and wraps it in a Box
sourcefn arced(&self) -> Arc<dyn Interaction + Send + Sync>
fn arced(&self) -> Arc<dyn Interaction + Send + Sync>
Clones this interaction and wraps it in an Arc
sourcefn thread_safe(&self) -> Arc<Mutex<dyn Interaction + Send + Sync>>
fn thread_safe(&self) -> Arc<Mutex<dyn Interaction + Send + Sync>>
Clones this interaction and wraps it in an Arc and Mutex
sourcefn matching_rules(&self) -> Option<MatchingRules>
fn matching_rules(&self) -> Option<MatchingRules>
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)
sourcefn is_v4_http(&self) -> bool
fn is_v4_http(&self) -> bool
If the interaction is V4 HTTP
sourcefn is_v4_async_message(&self) -> bool
fn is_v4_async_message(&self) -> bool
If the interaction is a V4 message
sourceimpl V4Interaction for SynchronousMessage
impl V4Interaction for SynchronousMessage
sourcefn to_super(&self) -> &(dyn Interaction + Send + Sync)
fn to_super(&self) -> &(dyn Interaction + Send + Sync)
Convert the interaction to its super trait
sourcefn to_super_mut(&mut self) -> &mut (dyn Interaction + Send + Sync)
fn to_super_mut(&mut self) -> &mut (dyn Interaction + Send + Sync)
Convert the interaction to its super trait
sourcefn boxed_v4(&self) -> Box<dyn V4Interaction + Send + Sync>
fn boxed_v4(&self) -> Box<dyn V4Interaction + Send + Sync>
Clones this interaction and wraps it in a box
sourcefn comments(&self) -> HashMap<String, Value>
fn comments(&self) -> HashMap<String, Value>
Annotations and comments associated with this interaction
sourcefn comments_mut(&mut self) -> &mut HashMap<String, Value>
fn comments_mut(&mut self) -> &mut HashMap<String, Value>
Mutable access to the annotations and comments associated with this interaction
sourcefn v4_type(&self) -> V4InteractionType
fn v4_type(&self) -> V4InteractionType
Type of this V4 interaction
sourcefn plugin_config(&self) -> HashMap<String, HashMap<String, Value>>
fn plugin_config(&self) -> HashMap<String, HashMap<String, Value>>
Any configuration added to the interaction from a plugin
sourcefn plugin_config_mut(&mut self) -> &mut HashMap<String, HashMap<String, Value>>
fn plugin_config_mut(&mut self) -> &mut HashMap<String, HashMap<String, Value>>
Any configuration added to the interaction from a plugin
sourcefn interaction_markup(&self) -> InteractionMarkup
fn interaction_markup(&self) -> InteractionMarkup
Markup added to the interaction to render in UIs
sourcefn interaction_markup_mut(&mut self) -> &mut InteractionMarkup
fn interaction_markup_mut(&mut self) -> &mut InteractionMarkup
Markup added to the interaction to render in UIs
sourcefn set_transport(&mut self, transport: Option<String>)
fn set_transport(&mut self, transport: Option<String>)
Set the transport used with the interaction
sourcefn with_unique_key(&self) -> Box<dyn V4Interaction + Send + Sync>
fn with_unique_key(&self) -> Box<dyn V4Interaction + Send + Sync>
Creates a new version with a calculated key
sourcefn unique_key(&self) -> String
fn unique_key(&self) -> String
Returns the current key if set, otherwise calculates a new one
impl Eq for SynchronousMessage
impl StructuralEq for SynchronousMessage
Auto Trait Implementations
impl RefUnwindSafe for SynchronousMessage
impl Send for SynchronousMessage
impl Sync for SynchronousMessage
impl Unpin for SynchronousMessage
impl UnwindSafe for SynchronousMessage
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more