Struct Address

pub struct Address { /* private fields */ }

An address used to connect to a NATS server

An Address consists of a domain, a port number, and an optional Authorization. The domain can simply be the string representation of an IP address or a true domain name that will be resolved through DNS.

The string representation of an Address can take the following forms:

• nats://<username>:<password>@<domain>:<port>
• nats://<token>@<domain>:<port>

The only required part of the address string is the <domain>. This makes the simplest address solely an IP address (eg 127.0.0.1). If no port is specified the default, port 4222, is used.

Note: When a client attempts to connect to the server at an address, the authorization specified by the address will always override the client’s Connect default authorization.

Example

use rants::Address;

let address = "nats://username:password@127.0.0.1:8080".parse::<Address>();
assert!(address.is_ok());
let address = "auth_token@1.2.3.4".parse::<Address>();
assert!(address.is_ok());
let address = "nats://auth_token@1.2.3.4:5780".parse::<Address>();
assert!(address.is_ok());

Implementations

impl Address

pub fn new( domain: &str, port: u16, authorization: Option<Authorization>, ) -> Self

Create a new Address

pub fn domain(&self) -> &str

Get the Address’s domain

pub fn port(&self) -> u16

Get the Address’s port

pub fn address(&self) -> (&str, u16)

Get the Address’s domain and port

pub fn authorization(&self) -> Option<&Authorization>

Get the Address’s Authorization

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Address

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl FromStr for Address

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Address

fn eq(&self, other: &Address) -> 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 StructuralPartialEq for Address