Struct ratsio::nats_client::NatsClientOptions

pub struct NatsClientOptions {
    pub username: String,
    pub password: String,
    pub auth_token: String,
    pub tls_required: bool,
    pub verbose: bool,
    pub pedantic: bool,
    pub echo: bool,
    pub name: String,
    pub cluster_uris: UriVec,
    pub ping_interval: u16,
    pub ping_max_out: u16,
    pub subscribe_on_reconnect: bool,
    pub ensure_connect: bool,
    pub reconnect_timeout: u64,
    pub user_jwt: Option<UserJWT>,
    pub nkey: Option<String>,
}

Fields

username: String

Cluster username, can be overwritten by host url nats://:@:

password: String

Cluster password, can be overwritten by host url nats://:@:

auth_token: String

Cluster auth_token

tls_required: bool

Whether TLS is required.

verbose: bool

verbosity, default true

pedantic: bool

pedantic, default false

echo: bool

pedantic, default true

name: String

Optional client name

cluster_uris: UriVec

Cluster URI in the IP:PORT format

ping_interval: u16

Ping interfval in seconds

ping_max_out: u16

No of unsuccessful pings before the connection is deemed disconnected.

subscribe_on_reconnect: bool

If we should re-subscribe all subscriptions on re-connection. If you don't want re-subscription, add a reconnect_handler and do your thing there.

ensure_connect: bool

If connect fails, keep trying, forever,

reconnect_timeout: u64

Time between connection retries

user_jwt: Option<UserJWT>

When using NATS 2.x decentralized security, supply a user JWT for authN/authZ

nkey: Option<String>

Nkey authentication

Implementations

impl NatsClientOptions

pub fn builder() -> NatsClientOptionsBuilder

Trait Implementations

impl Clone for NatsClientOptions

fn clone(&self) -> NatsClientOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NatsClientOptions

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

Formats the value using the given formatter.

impl Default for NatsClientOptions

fn default() -> Self

Returns the "default value" for a type.

impl<'_> From<&'_ str> for NatsClientOptions

fn from(uri: &str) -> Self

Performs the conversion.

impl From<String> for NatsClientOptions

fn from(uri: String) -> Self

Performs the conversion.

impl<'_> From<Vec<&'_ str>> for NatsClientOptions

fn from(uris: Vec<&str>) -> Self

Performs the conversion.

impl From<Vec<String>> for NatsClientOptions

fn from(uris: Vec<String>) -> Self

Performs the conversion.

impl PartialEq<NatsClientOptions> for NatsClientOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for NatsClientOptions