Struct Address

pub struct Address(/* private fields */);

Address that nameservice has returned

We hide this structure to allow future additions. There is Builder which provides a forward compatible way to build such address in a resolver and there are methods to extract data from it.

Internally it’s an Arc over a structure so it’s cheap to clone and you can cache addresses.

Implementations

impl Address

pub fn pick_one(&self) -> Option<SocketAddr>

Select one random address to connect to

Picks a single address from the set of high priority addresses, with the random distribution according to the weights.

This method is stateless so it can’t find out that high priority addresses are all inaccessible and fallback addresses should be used.

Returns None if address is empty

pub fn addresses_at(&self, priority: usize) -> OwnedAddressIter

Returns an owned iterator over addresses at priority

This is similar to self.at(pri).addresses() but returns an owned object that implements IntoIterator. This might be useful for streams and futures where borrowed objects don’t work

pub fn at(&self, priority: usize) -> WeightedSet<'_>

Returns the set of the hosts for the same priority

Note: original priorities are lost. This method has contiguous array of sets of hosts. The highest priority hosts returned by .at(0).

If no hosts the priority exists returns an empty set

Use iter() to iterate over WeightedSet’s by priority

pub fn iter(&self) -> PriorityIter<'_>

Returns iterator over WeightedSet’s starting from high priority set

pub fn parse_list<I>(iter: I) -> Result<Address, AddrParseError>

where I: IntoIterator, I::Item: AsRef<str>,

Parse a list of strings and put it into an address

This only uses one layer of addresses with same weights. And is mostly useful for unit tests

Trait Implementations

impl AsRef<Address> for Address

fn as_ref(&self) -> &Address

Converts this type into a shared reference of the (usually inferred) input type.

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<'a> From<&'a [SocketAddr]> for Address

fn from(addr: &[SocketAddr]) -> Address

Converts to this type from the input type.

impl From<(IpAddr, u16)> for Address

fn from((ip, port): (IpAddr, u16)) -> Address

Converts to this type from the input type.

impl From<SocketAddr> for Address

fn from(addr: SocketAddr) -> Address

Converts to this type from the input type.

impl FromIterator<SocketAddr> for Address

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = SocketAddr>,

Creates a value from an iterator.

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 Eq for Address