Struct pact_models::message::Message

pub struct Message {
    pub id: Option<String>,
    pub description: String,
    pub provider_states: Vec<ProviderState>,
    pub contents: OptionalBody,
    pub metadata: HashMap<String, Value>,
    pub matching_rules: MatchingRules,
    pub generators: Generators,
}

Struct that defines a message.

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 message interaction. This needs to be unique in 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.

contents: OptionalBody

The contents of the message

metadata: HashMap<String, Value>

Metadata associated with this message.

matching_rules: MatchingRules

Matching rules

generators: Generators

Generators

Implementations

impl Message

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

Constructs a Message from the Json struct.

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

Converts this interaction to a Value struct. note: spec version is preserved for compatibility with the RequestResponsePact interface and for future use

pub fn message_content_type(&self) -> Option<ContentType>

Returns the content type of the message by returning the content type associated with the body, or by looking it up in the message metadata

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Message

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

Formats the value using the given formatter.

impl HttpPart for Message

fn headers(&self) -> &Option<HashMap<String, Vec<String>>>

Returns the headers of the HTTP part.

fn headers_mut(&mut self) -> &mut HashMap<String, Vec<String>>

Returns the headers of the HTTP part in a mutable form.

fn body(&self) -> &OptionalBody

Returns the body of the HTTP part.

fn matching_rules(&self) -> &MatchingRules

Returns the matching rules of the HTTP part.

fn generators(&self) -> &Generators

Returns the generators of the HTTP part.

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

Lookup up the content type for the part

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

Tries to detect the content type of the body by matching some regular expressions against the first 32 characters.

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

Determine the content type of the HTTP part. If a Content-Type header is present, the value of that header will be returned. Otherwise, the body will be inspected.

fn has_header(&self, header_name: &str) -> bool

Checks if the HTTP Part has the given header

fn lookup_header_value(&self, header_name: &str) -> Option<String>

Checks if the HTTP Part has the given header

fn has_text_body(&self) -> bool

If the body is a textual type (non-binary)

fn add_header(&mut self, key: &str, val: Vec<&str>)

Convenience method to add a header

fn build_generators(
    &self,
    category: &GeneratorCategory
) -> HashMap<DocPath, Generator>

Builds a map of generators from the generators and matching rules

impl Interaction for Message

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 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 contents(&self) -> OptionalBody

👎 Deprecated since 0.8.14:

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.8.14:

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

Returns the interaction in V4 format

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<SynchronousMessages>

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>

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

fn pending(&self) -> bool

If this interaction is pending (V4 only)

impl PartialEq<Message> for Message

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

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

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

This method tests for !=.

impl Serialize for Message

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message