Trait Interaction

Source

pub trait Interaction: Debug {
Show 31 methods    // Required methods
    fn type_of(&self) -> String;
    fn is_request_response(&self) -> bool;
    fn as_request_response(&self) -> Option<RequestResponseInteraction>;
    fn is_message(&self) -> bool;
    fn as_message(&self) -> Option<Message>;
    fn id(&self) -> Option<String>;
    fn description(&self) -> String;
    fn set_id(&mut self, id: Option<String>);
    fn set_description(&mut self, description: &str);
    fn provider_states(&self) -> Vec<ProviderState>;
    fn provider_states_mut(&mut self) -> &mut Vec<ProviderState>;
    fn contents(&self) -> OptionalBody;
    fn contents_for_verification(&self) -> OptionalBody;
    fn content_type(&self) -> Option<ContentType>;
    fn is_v4(&self) -> bool;
    fn as_v4(
        &self,
    ) -> Option<Box<dyn V4Interaction + Send + Sync + RefUnwindSafe>>;
    fn as_v4_mut(&mut self) -> Option<&mut dyn V4Interaction>;
    fn as_v4_http(&self) -> Option<SynchronousHttp>;
    fn as_v4_async_message(&self) -> Option<AsynchronousMessage>;
    fn as_v4_sync_message(&self) -> Option<SynchronousMessage>;
    fn as_v4_http_mut(&mut self) -> Option<&mut SynchronousHttp>;
    fn as_v4_async_message_mut(&mut self) -> Option<&mut AsynchronousMessage>;
    fn as_v4_sync_message_mut(&mut self) -> Option<&mut SynchronousMessage>;
    fn boxed(&self) -> Box<dyn Interaction + Send + Sync + RefUnwindSafe>;
    fn arced(&self) -> Arc<dyn Interaction + Send + Sync + RefUnwindSafe>;
    fn thread_safe(
        &self,
    ) -> Arc<Mutex<dyn Interaction + Send + Sync + RefUnwindSafe>>;
    fn matching_rules(&self) -> Option<MatchingRules>;

    // Provided methods
    fn is_v4_http(&self) -> bool { ... }
    fn is_v4_async_message(&self) -> bool { ... }
    fn is_v4_sync_message(&self) -> bool { ... }
    fn pending(&self) -> bool { ... }
}

Expand description

Interaction Trait

Required Methods§

Source

fn type_of(&self) -> String

The type of the interaction

Source

fn is_request_response(&self) -> bool

If this is a request/response interaction

Source

fn as_request_response(&self) -> Option<RequestResponseInteraction>

Returns the request/response interaction if it is one

Source

fn is_message(&self) -> bool

If this is a message interaction

Source

fn as_message(&self) -> Option<Message>

Returns the message interaction if it is one

Source

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

Interaction ID. This will only be set if the Pact file was fetched from a Pact Broker

Source

fn description(&self) -> String

Description of this interaction. This needs to be unique in the pact file.

Source

fn set_id(&mut self, id: Option<String>)

Set the Interaction ID

Source

fn set_description(&mut self, description: &str)

Set the description of this interaction. This needs to be unique in the pact file.

Source

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.

Source

fn provider_states_mut(&mut self) -> &mut Vec<ProviderState>

Mutable Optional provider states for the interaction. See <https://docs.pact.io/getting_started/provider_states> for more info on provider states.

Source

fn contents(&self) -> OptionalBody

👎Deprecated since 0.1.0: 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

Source

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

Source

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

👎Deprecated since 0.1.0: 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.

Source