Trait Pact

pub trait Pact: Debug + ReadWritePact {
    // Required methods
    fn consumer(&self) -> Consumer;
    fn provider(&self) -> Provider;
    fn interactions(
        &self,
    ) -> Vec<Box<dyn Interaction + Send + Sync + RefUnwindSafe>>;
    fn interactions_mut(&mut self) -> Vec<&mut (dyn Interaction + Send + Sync)>;
    fn metadata(&self) -> BTreeMap<String, BTreeMap<String, String>>;
    fn to_json(&self, pact_spec: PactSpecification) -> Result<Value>;
    fn as_request_response_pact(&self) -> Result<RequestResponsePact>;
    fn as_message_pact(&self) -> Result<MessagePact>;
    fn as_v4_pact(&self) -> Result<V4Pact>;
    fn specification_version(&self) -> PactSpecification;
    fn boxed(&self) -> Box<dyn Pact + Send + Sync + RefUnwindSafe>;
    fn arced(&self) -> Arc<dyn Pact + Send + Sync + RefUnwindSafe>;
    fn thread_safe(&self) -> Arc<Mutex<dyn Pact + Send + Sync + RefUnwindSafe>>;
    fn add_interaction(&mut self, interaction: &dyn Interaction) -> Result<()>;
    fn requires_plugins(&self) -> bool;
    fn plugin_data(&self) -> Vec<PluginData>;
    fn is_v4(&self) -> bool;
    fn add_plugin(
        &mut self,
        name: &str,
        version: &str,
        plugin_data: Option<HashMap<String, Value>>,
    ) -> Result<()>;
    fn add_md_version(&mut self, key: &str, version: &str);
}

Trait for a Pact (request/response or message)

Required Methods

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

Interactions in the Pact

fn interactions_mut(&mut self) -> Vec<&mut (dyn Interaction + Send + Sync)>

Mutable collection of interactions in the Pact

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

Pact metadata

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

Converts this pact to a Value struct.

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

Clones this Pact and wraps it in a Box

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

Clones this Pact and wraps it in an Arc

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

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: &str, plugin_data: Option<HashMap<String, Value>>, ) -> Result<()>

Add the plugin and plugin data to this Pact. If an entry already exists for the plugin, the plugin data will be merged

fn add_md_version(&mut self, key: &str, version: &str)

Adds some version info to the Pact-Rust metadata section

Trait Implementations

impl Clone for Box<dyn Pact>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Box<dyn Pact>

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Box<dyn Pact>

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

Tests for self and other values to be equal, and is used by ==.

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

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

Implementors

impl Pact for MessagePact

impl Pact for RequestResponsePact

impl Pact for V4Pact