Enum NetAddr 

pub enum NetAddr {
    Inet(IpAddr, u16),
    Name(Cow<'static, str>, u16),
}

A network address.

Either an IP address and port number or else a hostname and port number.

Variants

Inet(IpAddr, u16)

Name(Cow<'static, str>, u16)

Implementations

impl NetAddr

pub fn named<S>(name: S, port: u16) -> Self

where S: Into<Cow<'static, str>>,

pub fn port(&self) -> u16

Get the port number of an address.

pub fn set_port(&mut self, p: u16)

Set the address port.

pub fn with_port(self, p: u16) -> Self

pub fn with_offset(self, o: u16) -> Self

pub fn is_ip(&self) -> bool

pub fn is_probably_global(&self) -> bool

Whether this address is plausibly publicly routable. Returns false for IP literals in non-globally-routable ranges (loopback, unspecified, RFC 1918 private, link-local, broadcast, documentation, IPv6 multicast) and the literal localhost. Other hostnames are trusted and return true. Approximates the (still unstable) IpAddr::is_global using stable predicates; the IPv6 surface is incomplete (fe80::/10 link-local and fc00::/7 unique-local addresses are treated as global here).

pub fn validate(&self) -> Result<(), InvalidNetAddr>

Checks that this address is well-formed.

A hostname is dot-separated labels, each 1 to 63 characters of ASCII letters, digits, - and _, not beginning or ending with -, and not digits and dots alone. RFC 952 and RFC 1123 do not allow _, but names using it are in use. An IP address must be the address it prints as, so an IPv4 address in IPv6 form is not well-formed; IpAddr::to_canonical converts it.

Neither the port nor the length of the whole name is checked.

pub fn unbracketed_string(&self) -> String

The address without brackets around an IPv6 literal.

This is how fmt::Display printed every address before IPv6 literals were bracketed. The format is retained here for backwards compatibility.

Trait Implementations

impl Clone for NetAddr

fn clone(&self) -> NetAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NetAddr

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for NetAddr

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

Formats the value using the given formatter.

impl From<(&str, u16)> for NetAddr

fn from((h, p): (&str, u16)) -> Self

Converts to this type from the input type.

impl From<(IpAddr, u16)> for NetAddr

fn from((ip, p): (IpAddr, u16)) -> Self

Converts to this type from the input type.

impl From<(Ipv4Addr, u16)> for NetAddr

fn from((ip, p): (Ipv4Addr, u16)) -> Self

Converts to this type from the input type.

impl From<(Ipv6Addr, u16)> for NetAddr

fn from((ip, p): (Ipv6Addr, u16)) -> Self

Converts to this type from the input type.

impl From<(String, u16)> for NetAddr

fn from((h, p): (String, u16)) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for NetAddr

fn from(a: SocketAddr) -> Self

Converts to this type from the input type.

impl FromStr for NetAddr

Grammar:

addr = host               -- port is 0
     | host ":" port
     | "[" host "]"       -- port is 0
     | "[" host "]:" port

host = IP | name
IP   = <std::net::IpAddr>
name = <any sequence of characters, possibly empty>
port = <u16>

• Input starting with [ has the port after the last ]:. With no ]: anywhere there is no port, so [a:80 is the name [a:80 on port 0.
• Input not starting with [ has the port after the last : or defaults to 0 if there is no :.
• host is an IP if IpAddr parses it, a name otherwise.
• Parsing the port permits a leading + and leading zeros.

type Err = InvalidNetAddr

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 Hash for NetAddr

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

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 NetAddr

fn cmp(&self, other: &NetAddr) -> 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 NetAddr

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

fn partial_cmp(&self, other: &NetAddr) -> 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 NetAddr

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for NetAddr

type Error = InvalidNetAddr

The type returned in the event of a conversion error.

fn try_from(val: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for NetAddr

impl StructuralPartialEq for NetAddr