Struct pact_plugin_driver::proto::pact_plugin_client::PactPluginClient

pub struct PactPluginClient<T> { /* private fields */ }

Implementations

impl PactPluginClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> PactPluginClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> PactPluginClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn init_plugin( &mut self, request: impl IntoRequest<InitPluginRequest> ) -> Result<Response<InitPluginResponse>, Status>

Check that the plugin loaded OK. Returns the catalogue entries describing what the plugin provides

pub async fn update_catalogue( &mut self, request: impl IntoRequest<Catalogue> ) -> Result<Response<()>, Status>

Updated catalogue. This will be sent when the core catalogue has been updated (probably by a plugin loading).

pub async fn compare_contents( &mut self, request: impl IntoRequest<CompareContentsRequest> ) -> Result<Response<CompareContentsResponse>, Status>

Request to perform a comparison of some contents (matching request)

pub async fn configure_interaction( &mut self, request: impl IntoRequest<ConfigureInteractionRequest> ) -> Result<Response<ConfigureInteractionResponse>, Status>

Request to configure/setup the interaction for later verification. Data returned will be persisted in the pact file.

pub async fn generate_content( &mut self, request: impl IntoRequest<GenerateContentRequest> ) -> Result<Response<GenerateContentResponse>, Status>

Request to generate the content using any defined generators

pub async fn start_mock_server( &mut self, request: impl IntoRequest<StartMockServerRequest> ) -> Result<Response<StartMockServerResponse>, Status>

Start a mock server

pub async fn shutdown_mock_server( &mut self, request: impl IntoRequest<ShutdownMockServerRequest> ) -> Result<Response<ShutdownMockServerResponse>, Status>

Shutdown a running mock server TODO: Replace the message types with MockServerRequest and MockServerResults in the next major version

pub async fn get_mock_server_results( &mut self, request: impl IntoRequest<MockServerRequest> ) -> Result<Response<MockServerResults>, Status>

Get the matching results from a running mock server

pub async fn prepare_interaction_for_verification( &mut self, request: impl IntoRequest<VerificationPreparationRequest> ) -> Result<Response<VerificationPreparationResponse>, Status>

Prepare an interaction for verification. This should return any data required to construct any request so that it can be amended before the verification is run

pub async fn verify_interaction( &mut self, request: impl IntoRequest<VerifyInteractionRequest> ) -> Result<Response<VerifyInteractionResponse>, Status>

Execute the verification for the interaction.

Trait Implementations

impl<T: Clone> Clone for PactPluginClient<T>

fn clone(&self) -> PactPluginClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PactPluginClient<T>

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

Formats the value using the given formatter.