Struct NatsServerBuilder 

pub struct NatsServerBuilder { /* private fields */ }

Configuration for a NatsServer

Obtained from NatsServer::builder.

Implementations

impl NatsServerBuilder

pub fn jetstream(self) -> Self

Enable JetStream, storing data in the server’s temporary directory

pub fn jetstream_domain(self, domain: impl Into<String>) -> Self

Enable JetStream under the given domain

pub fn websocket(self) -> Self

Enable a plaintext WebSocket listener

pub fn user( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Require clients to authenticate, allowing username with password

Can be called multiple times to allow multiple users.

pub fn max_payload(self, max_payload: u32) -> Self

Set the maximum payload size accepted by the server

pub fn config(self, config: impl Into<String>) -> Self

Append raw lines to the generated server configuration file

pub async fn start(self) -> Option<NatsServer>

Start the server, waiting until it’s ready to accept clients

Returns None if no nats-server binary could be found and the CI environment variable isn’t set.

Panics

Panics if the binary is missing while running in CI, or if the server fails to start.

Trait Implementations

impl Debug for NatsServerBuilder

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

Formats the value using the given formatter.

impl Default for NatsServerBuilder

fn default() -> Self

Returns the “default value” for a type.