Struct Addr 

pub struct Addr { /* private fields */ }

A “host:port” network address.

The host can be a domain name, IPv4, or IPv6 address and the port must be a valid u16.

Addr ensures that the host part is a syntactically valid domain name or IP address. It provides methods for DNS lookup, conversion to socket addresses, and serde serialization/deserialization.

Implementations

impl Addr

pub fn new<T>(host: T, port: u16) -> Result<Addr, AddrError>

where T: AsRef<str>,

Creates a new Addr from a host representation and a port number.

The host can be a domain name (e.g., “spideroak.com”), an IPv4 address string (e.g., “192.168.1.1”), or an IPv6 address string (e.g., “::1”).

Returns an error if the host is not a valid domain name or IP address string.

Errors

Returns AddrError::InvalidAddr if the host string is not a valid domain name or IP address.

pub fn host(&self) -> &str

Returns a reference to the host part (domain name or IP address) of the Addr.

pub fn port(&self) -> u16

Returns the port number of the Addr.

pub async fn lookup(&self) -> Result<impl Iterator<Item = SocketAddr>, Error>

Performs an asynchronous DNS lookup for this Addr.

Resolves the host part of the address to one or more SocketAddr values.

pub fn to_socket_addrs(&self) -> impl ToSocketAddrs

Converts the Addr into a type that implements ToSocketAddrs.

Trait Implementations

impl Clone for Addr

fn clone(&self) -> Addr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Addr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Addr

fn deserialize<D>( deserializer: D, ) -> Result<Addr, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Addr

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

Formats the value using the given formatter.

impl<T> From<T> for Addr

where T: Into<SocketAddr>,

fn from(value: T) -> Addr

Converts to this type from the input type.

impl FromStr for Addr

fn from_str(s: &str) -> Result<Addr, <Addr as FromStr>::Err>

Parses a string into an Addr.

The string can be in several forms:

• host:port (e.g., “spideroak.com:80”, “192.168.1.1:8080”)
• IPv6 address with port: [ipv6_addr]:port (e.g., “[::1]:443”)
• A string representation of a SocketAddr (which std::net::SocketAddr::from_str can parse).

This function first attempts to parse using SocketAddr, then falls back to splitting the string at the first “:” character to parse the host and port.

Errors

Returns AddrError::InvalidAddr if the string format is invalid or the port number is malformed.

type Err = AddrError

The associated error which can be returned from parsing.

impl Hash for Addr

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Addr

fn cmp(&self, other: &Addr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Addr

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

fn partial_cmp(&self, other: &Addr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Addr

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Addr

impl Eq for Addr

impl StructuralPartialEq for Addr