Struct Iface 

pub struct Iface { /* private fields */ }

Representation of a host network interface.

Implementations

impl Iface

pub fn from_system(name: &str) -> Result<Self>

Resolve an interface from the operating system by its name.

When the interface carries several IPv4 addresses the first one is used; Iface::from_ipv4 preserves the address that was asked for.

pub fn from_ipv4(addr: Ipv4Addr) -> Result<Self>

Resolve an interface by one of its IPv4 addresses.

The resulting Iface reports addr itself, not whichever address the OS happens to list last for that interface. A multi-homed NIC — a stale DHCP lease alongside a link-local address, say — would otherwise resolve to a different address than the caller selected and bind the socket to the wrong one (#57).

pub fn from_remote_ipv4(remote: Ipv4Addr) -> Result<Self>

Resolve the local interface selected by the operating system for a remote IPv4 address.

pub fn list() -> Result<Vec<Self>>

Every interface the operating system reports, one entry per name.

This is the library’s own view of the machine, which is the point: #57 was an interface that existed but that we could not see, and no amount of ipconfig output would have shown that. Ordered by name so two runs can be diffed.

pub fn all_ipv4(&self) -> Result<Vec<Ipv4Addr>>

Every IPv4 address assigned to this interface.

Iface::ipv4 reports the one the socket will bind to; a multi-homed NIC has more, and which ones they are is exactly the question #57 turned on.

pub fn name(&self) -> &str

Interface name as provided by the operating system (e.g. eth0).

pub fn index(&self) -> u32

Interface index as reported by the kernel. The index is used by some socket options (e.g. multicast subscriptions).

pub fn ipv4(&self) -> Option<Ipv4Addr>

Primary IPv4 address associated with the interface, if any.

pub fn ipv6(&self) -> Option<Ipv6Addr>

Primary IPv6 address associated with the interface, if any.

Trait Implementations

impl Clone for Iface

fn clone(&self) -> Iface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Iface

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

Formats the value using the given formatter.

impl PartialEq for Iface

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

impl StructuralPartialEq for Iface