Struct pact_matching_ffi::models::message_pact::MessagePact

pub struct MessagePact {
    pub consumer: Consumer,
    pub provider: Provider,
    pub messages: Vec<Message, Global>,
    pub metadata: BTreeMap<String, BTreeMap<String, String>>,
    pub specification_version: PactSpecification,
}

Struct that represents a pact between the consumer and provider of a service. It contains a list of Messages instead of Interactions, but is otherwise identical to struct Pact.

Fields

consumer: Consumer

Consumer side of the pact

provider: Provider

Provider side of the pact

messages: Vec<Message, Global>

List of messages between the consumer and provider.

metadata: BTreeMap<String, BTreeMap<String, String>>

Metadata associated with this pact file.

specification_version: PactSpecification

Specification version of this pact

Implementations

impl MessagePact

pub fn spec_version(&self) -> PactSpecification

Returns the specification version of this pact

pub fn from_json(file: &str, pact_json: &Value) -> Result<MessagePact, Error>

Creates a MessagePact from a Value struct.

pub fn metadata_to_json(
    &self,
    pact_spec: &PactSpecification
) -> BTreeMap<String, Value>

Creates a BTreeMap of the metadata of this pact.

pub fn default_file_name(&self) -> String

Determines the default file name for the pact. This is based on the consumer and provider names.

pub fn from_url(
    url: &String,
    auth: &Option<HttpAuth>
) -> Result<MessagePact, Error>

Reads the pact file from a URL and parses the resulting JSON into a MessagePact struct

pub fn overwrite_pact(
    &self,
    path: &Path,
    pact_spec: PactSpecification
) -> Result<(), Error>

Writes this pact out to the provided file path. All directories in the path will automatically created. If there is already a file at the path, it will be overwritten.

pub fn default() -> MessagePact

Returns a default MessagePact struct

pub fn default_metadata() -> BTreeMap<String, BTreeMap<String, String>>

Returns the default metadata

Trait Implementations

impl Clone for MessagePact

pub fn clone(&self) -> MessagePact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessagePact

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessagePact

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

Deserialize this value from the given Serde deserializer.

impl Pact for MessagePact

pub fn to_json(&self, pact_spec: PactSpecification) -> Result<Value, Error>

Converts this pact to a Value struct.

pub fn consumer(&self) -> Consumer

Consumer side of the pact

pub fn provider(&self) -> Provider

Provider side of the pact

pub fn interactions(&self) -> Vec<&dyn Interaction, Global>

Interactions in the Pact

pub fn metadata(&self) -> BTreeMap<String, BTreeMap<String, String>>

Pact metadata

pub fn as_request_response_pact(&self) -> Result<RequestResponsePact, Error>

Attempt to downcast to a concrete Pact

pub fn as_message_pact(&self) -> Result<MessagePact, Error>

Attempt to downcast to a concrete Message Pact

pub fn as_v4_pact(&self) -> Result<V4Pact, Error>

Attempt to downcast to a concrete V4 Pact

pub fn specification_version(&self) -> PactSpecification

Specification version of this Pact

pub fn boxed(&self) -> Box<dyn Pact + Send + 'static, Global>

Clones this Pact and wraps it in a Box

pub fn arced(&self) -> Arc<dyn Pact + Send + 'static>

Clones this Pact and wraps it in an Arc

pub fn thread_safe(&self) -> Arc<Mutex<dyn Pact + Sync + Send + 'static>>

Clones this Pact and wraps it in an Arc and Mutex

pub fn add_interaction(
    &mut self,
    interaction: &dyn Interaction
) -> Result<(), Error>

Adds an interactions in the Pact

impl PactJsonVerifier for MessagePact

pub fn verify_json(
    path: &str,
    pact_json: &Value,
    _strict: bool
) -> Vec<PactFileVerificationResult, Global>

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

impl ReadWritePact for MessagePact

pub fn read_pact(path: &Path) -> Result<MessagePact, Error>

Reads the pact file and parses the resulting JSON into a Pact struct

pub fn merge(
    &self,
    pact: &dyn Pact
) -> Result<Box<dyn Pact + 'static, Global>, Error>

Merges this pact with the other pact, and returns a new Pact with the interactions sorted. Returns an error if there is a merge conflict, which will occur if the other pact is a different type, or if a V3 Pact then if any interaction has the same description and provider state and the requests and responses are different.

pub fn default_file_name(&self) -> String

Determines the default file name for the pact. This is based on the consumer and provider names.

impl Serialize for MessagePact

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

Serialize this value into the given Serde serializer.