Struct async_nats::ConnectOptions

pub struct ConnectOptions { /* private fields */ }

Connect options.

Implementations

impl ConnectOptions

pub fn new() -> Self

Enables customization of NATS connection.

Examples

let mut options = async_nats::ConnectOptions::new();
let nc = options.connect("demo.nats.io").await?;

pub async fn connect<A: ToServerAddrs>(&mut self, addrs: A) -> Result<Client>

Connect to the NATS Server leveraging all passed options.

Examples

let nc = async_nats::ConnectOptions::new().require_tls(true).connect("demo.nats.io").await?;

pub fn add_root_certificates(&mut self, path: PathBuf) -> &mut ConnectOptions

Loads root certificates by providing the path to them.

Examples

let nc =
async_nats::ConnectOptions::new().add_root_certificates("mycerts.pem".into()).connect("demo.nats.io").await?;

pub fn add_client_certificate(
    &mut self,
    cert: PathBuf,
    key: PathBuf
) -> &mut ConnectOptions

Loads client certificate by providing the path to it.

Examples

let nc =
async_nats::ConnectOptions::new().add_client_certificate("cert.pem".into(), "key.pem".into()).connect("demo.nats.io").await?;

pub fn require_tls(&mut self, is_required: bool) -> &mut ConnectOptions

Sets or disables TLS requirement. If TLS connection is impossible while options.require_tls(true) connection will return error.

Examples

let nc =
async_nats::ConnectOptions::new().require_tls(true).connect("demo.nats.io").await?;

pub fn flush_interval(
    &mut self,
    flush_interval: Duration
) -> &mut ConnectOptions

Sets the interval for flushing. NATS connection will send buffered data to the NATS Server whenever buffer limit is reached, but it is also necessary to flush once in a while if client is sending rarely and small messages. Flush interval allows to modify that interval.

Examples

async_nats::ConnectOptions::new().flush_interval(Duration::from_millis(100)).connect("demo.nats.io").await?;

pub fn ping_interval(&mut self, ping_interval: Duration) -> &mut ConnectOptions

Sets how often Client sends PING message to the server.

Examples

async_nats::ConnectOptions::new().flush_interval(Duration::from_millis(100)).connect("demo.nats.io").await?;

Trait Implementations

impl Clone for ConnectOptions

fn clone(&self) -> ConnectOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectOptions

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

Formats the value using the given formatter.

impl Default for ConnectOptions

fn default() -> ConnectOptions

Returns the “default value” for a type.