Struct pact_models::sync_pact::RequestResponsePact

pub struct RequestResponsePact {
    pub consumer: Consumer,
    pub provider: Provider,
    pub interactions: Vec<RequestResponseInteraction>,
    pub metadata: BTreeMap<String, BTreeMap<String, String>>,
    pub specification_version: PactSpecification,
}

Struct that represents a pact between the consumer and provider of a service.

Fields

consumer: Consumer

Consumer side of the pact

provider: Provider

Provider side of the pact

interactions: Vec<RequestResponseInteraction>

List of interactions 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 RequestResponsePact

pub fn spec_version(&self) -> PactSpecification

Returns the specification version of this pact

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

Creates a Pact 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 from_url(
    url: &str,
    auth: &Option<HttpAuth>
) -> Result<RequestResponsePact>

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

pub fn default() -> RequestResponsePact

Returns a default RequestResponsePact struct

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

Returns the default metadata

pub fn schema(spec_version: PactSpecification) -> Value

Generate the JSON schema properties for the given Pact specification

Trait Implementations

impl Clone for RequestResponsePact

fn clone(&self) -> RequestResponsePact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestResponsePact

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

Formats the value using the given formatter.

impl Default for RequestResponsePact

fn default() -> RequestResponsePact

Returns the “default value” for a type.

impl Pact for RequestResponsePact

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

Converts this pact to a Value struct.

fn consumer(&self) -> Consumer

Consumer side of the pact

fn provider(&self) -> Provider

Provider side of the pact

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

Interactions in the Pact

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

Pact metadata

fn as_request_response_pact(&self) -> Result<RequestResponsePact>

Attempt to downcast to a concrete Pact

fn as_message_pact(&self) -> Result<MessagePact>

Attempt to downcast to a concrete Message Pact

fn as_v4_pact(&self) -> Result<V4Pact>

Attempt to downcast to a concrete V4 Pact

fn specification_version(&self) -> PactSpecification

Specification version of this Pact

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

Clones this Pact and wraps it in a Box

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

Clones this Pact and wraps it in an Arc

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

Clones this Pact and wraps it in an Arc and Mutex

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

Adds an interactions in the Pact

fn requires_plugins(&self) -> bool

If this Pact needs any plugins loaded

fn plugin_data(&self) -> Vec<PluginData>

Plugins required for this Pact. These will be taken from the ‘plugins’ key in the pact metadata.

fn is_v4(&self) -> bool

If this is a V4 Pact

fn add_plugin(&mut self, _name: &str, _version: Option<String>) -> Result<()>

Add the plugin to this Pact

impl PactJsonVerifier for RequestResponsePact

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

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

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

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

This method tests for !=.

impl ReadWritePact for RequestResponsePact

fn read_pact(path: &Path) -> Result<RequestResponsePact>

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

fn merge(&self, pact: &dyn Pact) -> Result<Box<dyn Pact + Send + Sync>>

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.

fn default_file_name(&self) -> String

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

impl StructuralPartialEq for RequestResponsePact