Struct NatsServer 

pub struct NatsServer { /* private fields */ }

A nats-server process owned by a single test

The process is killed when this is dropped. If the test is panicking, the tail of the server log is printed and the temporary directory holding the config, the full log and the JetStream store is kept around for inspection.

Implementations

impl NatsServer

pub fn builder() -> NatsServerBuilder

Configure a new server

pub fn client_url(&self) -> &str

The nats:// URL clients should connect to

pub fn websocket_url(&self) -> Option<&str>

The ws:// URL clients should connect to

Returns None unless NatsServerBuilder::websocket was called.

pub async fn monitor(&self, path_and_query: &str) -> Value

Query a monitoring endpoint, like /connz?subs=1 or /varz

Panics

Panics if the request fails or the response isn’t successful JSON.

pub async fn connections(&self) -> Vec<Value>

The connections currently open with the server, including their subscriptions

Shorthand for the connections array of /connz?subs=1.

pub fn lame_duck(&self)

Put the server into Lame Duck Mode

pub fn pause(&self)

Freeze the server process, leaving its sockets open

pub fn resume(&self)

Resume a server frozen by NatsServer::pause

pub async fn shutdown(&mut self)

Gracefully shut the server down and wait for it to exit

Panics

Panics if waiting on the process fails.

pub async fn log(&self) -> String

The full server log

Trait Implementations

impl Debug for NatsServer

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

Formats the value using the given formatter.

impl Drop for NatsServer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.