Struct NatsConfig 

pub struct NatsConfig {
    pub host: String,
    pub port: u16,
    pub store_dir: PathBuf,
    pub js_domain: Option<String>,
    pub remote_url: Option<String>,
    pub credentials: Option<PathBuf>,
    pub websocket_port: u16,
    pub config_path: Option<PathBuf>,
}

Configuration for a NATS server that supports running either in “standalone” or “leaf” mode. See the respective NatsConfig::new_standalone and NatsConfig::new_leaf implementations below for more information.

Fields

host: String

port: u16

store_dir: PathBuf

The path where the NATS server will store its jetstream data. This must be different for each NATS server you spin up, otherwise they will share stream data

js_domain: Option<String>

remote_url: Option<String>

credentials: Option<PathBuf>

websocket_port: u16

config_path: Option<PathBuf>

Implementations

impl NatsConfig

pub fn new_leaf( host: &str, port: u16, js_domain: Option<String>, remote_url: String, credentials: PathBuf, websocket_port: u16, config_path: Option<PathBuf>, ) -> Self

Instantiates config for a NATS leaf node. Leaf nodes are meant to extend an existing NATS infrastructure like Synadia’s NGS, but can also be used to extend your own NATS infrastructure. For more information, our Working with Leaf Nodes docs

Arguments

• host: NATS host to listen on, e.g. 127.0.0.1
• port: NATS port to listen on, e.g. 4222
• js_domain: Jetstream domain to use, defaults to core. See Configuring Jetstream for more information
• remote_url: URL of NATS cluster to extend
• credentials: Credentials to authenticate to the existing NATS cluster

pub fn new_standalone(host: &str, port: u16, js_domain: Option<String>) -> Self

Instantiates config for a standalone NATS server. Unless you’re looking to extend existing NATS infrastructure, this is the preferred NATS server mode.

Arguments

• host: NATS host to listen on, e.g. 127.0.0.1
• port: NATS port to listen on, e.g. 4222
• js_domain: Jetstream domain to use, defaults to core. See Configuring Jetstream for more information

pub async fn write_to_path<P>(self, path: P) -> Result<()>

where P: AsRef<Path>,

Trait Implementations

impl Clone for NatsConfig

fn clone(&self) -> NatsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NatsConfig

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

Formats the value using the given formatter.

impl Default for NatsConfig

Returns a standalone NATS config with the following values:

• host: 127.0.0.1
• port: 4222
• js_domain: Some("core")
• remote_url: None
• credentials: None
• websocket_port: 4223

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for NatsConfig

fn eq(&self, other: &NatsConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NatsConfig

impl StructuralPartialEq for NatsConfig