Struct pact_mock_server::mock_server::MockServer

pub struct MockServer {
    pub id: String,
    pub scheme: MockServerScheme,
    pub port: Option<u16>,
    pub address: Option<String>,
    pub resources: Vec<CString>,
    pub pact: Arc<Mutex<dyn Pact + Send + Sync>>,
    pub config: MockServerConfig,
    pub metrics: MockServerMetrics,
    // some fields omitted
}

Struct to represent the “foreground” part of mock server

Fields

id: String

Mock server unique ID

scheme: MockServerScheme

Scheme the mock server is using

port: Option<u16>

Port the mock server is running on

address: Option<String>

Address the mock server is bound to

resources: Vec<CString>

List of resources that need to be cleaned up when the mock server completes

pact: Arc<Mutex<dyn Pact + Send + Sync>>

Pact that this mock server is based on

config: MockServerConfig

Mock server config

metrics: MockServerMetrics

Metrics collected by the mock server

Implementations

impl MockServer

pub async fn new(
    id: String,
    pact: Box<dyn Pact + Send + Sync>,
    addr: SocketAddr,
    config: MockServerConfig
) -> Result<(Arc<Mutex<MockServer>>, impl Future<Output = ()>), String>

Create a new mock server, consisting of its state (self) and its executable server future.

pub async fn new_tls(
    id: String,
    pact: Box<dyn Pact>,
    addr: SocketAddr,
    tls: &ServerConfig,
    config: MockServerConfig
) -> Result<(Arc<Mutex<MockServer>>, impl Future<Output = ()>), String>

Create a new TLS mock server, consisting of its state (self) and its executable server future.

pub fn shutdown(&mut self) -> Result<(), String>

Send the shutdown signal to the server

pub fn to_json(&self) -> Value

Converts this mock server to a Value struct

pub fn matches(&self) -> Vec<MatchResult>

Returns all collected matches

pub fn mismatches(&self) -> Vec<MatchResult>

Returns all the mismatches that have occurred with this mock server

pub fn write_pact(
    &self,
    output_path: &Option<String>,
    overwrite: bool
) -> Result<()>

Mock server writes its pact out to the provided directory

pub fn url(&self) -> String

Returns the URL of the mock server

Trait Implementations

impl Clone for MockServer

fn clone(&self) -> MockServer

Make a clone all of the MockServer fields. Note that the clone of the original server cannot be shut down directly.

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

Performs copy-assignment from source.

impl Debug for MockServer

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

Formats the value using the given formatter.

impl Default for MockServer

fn default() -> Self

Returns the “default value” for a type.