Struct gio::NetworkAddress

pub struct NetworkAddress(_, _);

NetworkAddress provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families.

The enumeration results of resolved addresses may be cached as long as this object is kept alive which may have unexpected results if alive for too long.

See SocketConnectable for an example of using the connectable interface.

Implements

NetworkAddressExt, glib::object::ObjectExt, SocketConnectableExt

Methods

impl NetworkAddress

pub fn new(hostname: &str, port: u16) -> NetworkAddress

Creates a new SocketConnectable for connecting to the given hostname and port.

Note that depending on the configuration of the machine, a hostname of localhost may refer to the IPv4 loopback address only, or to both IPv4 and IPv6; use NetworkAddress::new_loopback to create a NetworkAddress that is guaranteed to resolve to both addresses.

hostname

the hostname

port

the port

Returns

the new NetworkAddress

pub fn new_loopback(port: u16) -> NetworkAddress

Creates a new SocketConnectable for connecting to the local host over a loopback connection to the given port. This is intended for use in connecting to local services which may be running on IPv4 or IPv6.

The connectable will return IPv4 and IPv6 loopback addresses, regardless of how the host resolves localhost. By contrast, NetworkAddress::new will often only return an IPv4 address when resolving localhost, and an IPv6 address for localhost6.

NetworkAddressExt::get_hostname will always return localhost for a NetworkAddress created with this constructor.

Feature: v2_44

port

the port

Returns

the new NetworkAddress

pub fn parse(
    host_and_port: &str,
    default_port: u16
) -> Result<NetworkAddress, Error>

Creates a new SocketConnectable for connecting to the given hostname and port. May fail and return None in case parsing host_and_port fails.

host_and_port may be in any of a number of recognised formats; an IPv6 address, an IPv4 address, or a domain name (in which case a DNS lookup is performed). Quoting with [] is supported for all address types. A port override may be specified in the usual way with a colon.

If no port is specified in host_and_port then default_port will be used as the port number to connect to.

In general, host_and_port is expected to be provided by the user (allowing them to give the hostname, and a port override if necessary) and default_port is expected to be provided by the application.

(The port component of host_and_port can also be specified as a service name rather than as a numeric port, but this functionality is deprecated, because it depends on the contents of /etc/services, which is generally quite sparse on platforms other than Linux.)

host_and_port

the hostname and optionally a port

default_port

the default port if not in host_and_port

Returns

the new NetworkAddress, or None on error

pub fn parse_uri(uri: &str, default_port: u16) -> Result<NetworkAddress, Error>

Creates a new SocketConnectable for connecting to the given uri. May fail and return None in case parsing uri fails.

Using this rather than NetworkAddress::new or NetworkAddress::parse allows SocketClient to determine when to use application-specific proxy protocols.

uri

the hostname and optionally a port

default_port

The default port if none is found in the URI

Returns

the new NetworkAddress, or None on error

Trait Implementations

impl Clone for NetworkAddress

fn clone(&self) -> NetworkAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkAddress

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

Formats the value using the given formatter.

impl Display for NetworkAddress

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

Formats the value using the given formatter.

impl Eq for NetworkAddress

impl Hash for NetworkAddress

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, 

Feeds a slice of this type into the given [Hasher].

impl IsA<SocketConnectable> for NetworkAddress

impl Ord for NetworkAddress

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for NetworkAddress

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for NetworkAddress

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Send for NetworkAddress

impl StaticType for NetworkAddress

fn static_type() -> Type

Returns the type identifier of Self.

impl Sync for NetworkAddress