Struct interfaces::Interface

pub struct Interface {
    pub name: String,
    pub addresses: Vec<Address>,
    pub flags: InterfaceFlags,
    // some fields omitted
}

The Interface structure represents a single interface on the system. It also contains methods to control the interface.

Fields

name: String

The name of this interface.

addresses: Vec<Address>

All addresses for this interface.

flags: InterfaceFlags

Interface flags.

NOTE: The underlying API returns this value for each address of an interface, not each interface itself. We assume that they are all equal and take the first set of flags (from the first address).

Implementations

impl Interface

pub fn get_all() -> Result<Vec<Interface>>

Retrieve a list of all interfaces on this system.

pub fn get_by_name(name: &str) -> Result<Option<Interface>>

Returns an Interface instance representing the interface with the given name. Will return Ok(Some(Interface)) on success, Ok(None) if there is no such interface, and Err(..) on failure.

let iface = Interface::get_by_name("lo")?;
if let Some(ref lo) = iface {
    assert!(lo.is_loopback());
} else {
    println!("Could not find loopback interface");
}

pub fn is_up(&self) -> bool

Returns whether this interface is up.

pub fn is_running(&self) -> bool

Returns whether this interface is ready for transfer.

pub fn is_loopback(&self) -> bool

Returns whether this interface is a loopback address.

pub fn hardware_addr(&self) -> Result<HardwareAddr>

Retrieves the hardware address of this interface.

pub fn set_up(&mut self, up: bool) -> Result<()>

Sets the interface as up or down. This will change the status of the given interface in the system, and update the flags of this Interface instance.

pub fn get_mtu(&self) -> Result<u32>

Retrieve the MTU of this interface.

Trait Implementations

impl Debug for Interface

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

Formats the value using the given formatter.

impl Drop for Interface

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Interface

impl PartialEq<Interface> for Interface

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

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

#[must_use]

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

This method tests for !=.