Struct nats::ConnectionOptions

pub struct ConnectionOptions<TypeState> { /* fields omitted */ }

A configuration object for a NATS connection.

Methods

impl ConnectionOptions<NoAuth>

pub fn new() -> ConnectionOptions<NoAuth>

ConnectionOptions for establishing a new NATS Connection.

Example

let options = nats::ConnectionOptions::new();
let nc = options.connect("demo.nats.io")?;

pub fn with_token(self, token: &str) -> ConnectionOptions<Authenticated>

Authenticate with NATS using a token.

Example

let nc = nats::ConnectionOptions::new()
    .with_token("t0k3n!")
    .connect("demo.nats.io")?;

pub fn with_user_pass(
    self,
    user: &str,
    password: &str
) -> ConnectionOptions<Authenticated>

Authenticate with NATS using a username and password.

Example

let nc = nats::ConnectionOptions::new()
    .with_user_pass("derek", "s3cr3t!")
    .connect("demo.nats.io")?;

impl<TypeState> ConnectionOptions<TypeState>

pub fn with_name(self, name: &str) -> ConnectionOptions<TypeState>

Add a name option to this configuration.

Example

let nc = nats::ConnectionOptions::new()
    .with_name("My App")
    .connect("demo.nats.io")?;

pub const fn no_echo(self) -> ConnectionOptions<TypeState>

Select option to not deliver messages that we have published.

Example

let nc = nats::ConnectionOptions::new()
    .no_echo()
    .connect("demo.nats.io")?;

pub const fn max_reconnects(
    self,
    max_reconnects: Option<usize>
) -> ConnectionOptions<TypeState>

Set the maximum number of reconnect attempts. If no servers remain that are under this threshold, all servers will still be attempted.

Example

let nc = nats::ConnectionOptions::new()
    .max_reconnects(Some(3))
    .connect("demo.nats.io")?;

pub const fn reconnect_buffer_size(
    self,
    reconnect_buffer_size: usize
) -> ConnectionOptions<TypeState>

Set the maximum amount of bytes to buffer when accepting outgoing traffic in disconnected mode.

Example

let nc = nats::ConnectionOptions::new()
    .reconnect_buffer_size(64 * 1024)
    .connect("demo.nats.io")?;

pub fn connect(self, nats_url: &str) -> Result<Connection>

Establish a Connection with a NATS server.

Example

let options = nats::ConnectionOptions::new();
let nc = options.connect("demo.nats.io")?;

pub fn set_disconnect_callback<F>(self, cb: F) -> Self where
    F: Fn(&ServerInfo) + Send + Sync + 'static, 

Set a callback to be executed when connectivity to a server has been lost.

pub fn set_reconnect_callback<F>(self, cb: F) -> Self where
    F: Fn(&ServerInfo) + Send + Sync + 'static, 

Set a callback to be executed when connectivity to a server has been established.

Trait Implementations

impl<TypeState: Clone> Clone for ConnectionOptions<TypeState>

fn clone(&self) -> ConnectionOptions<TypeState>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TypeState: Debug> Debug for ConnectionOptions<TypeState>

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

Formats the value using the given formatter.

impl Default for ConnectionOptions<NoAuth>

fn default() -> ConnectionOptions<NoAuth>

Returns the "default value" for a type.