Struct Interface 

pub struct Interface { /* private fields */ }

The inferface struct

Implementations

impl Interface

pub const fn index(&self) -> u32

Returns the interface index.

pub const fn name(&self) -> &SmolStr

Returns the interface name.

pub const fn mtu(&self) -> u32

Returns the interface MTU.

pub const fn mac_addr(&self) -> Option<MacAddr>

Returns the hardware address of the interface.

pub const fn flags(&self) -> Flags

Returns the flags of the interface.

pub fn addrs(&self) -> Result<SmallVec<IfNet>>

Returns a list of unicast interface addrs for a specific interface.

pub fn addrs_by_filter<F>(&self, f: F) -> Result<SmallVec<IfNet>>

where F: FnMut(&IpAddr) -> bool,

Returns a list of unicast interface addrs for a specific interface. The filter is used to determine which multicast addresses to include.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();
let addrs = interface.addrs_by_filter(|addr| { addr.is_loopback() }).unwrap();

for addr in addrs {
  println!("Addr: {}", addr);
}

pub fn ipv4_addrs(&self) -> Result<SmallVec<Ifv4Net>>

Returns a list of unicast, IPv4 interface addrs for a specific interface.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv4_addrs().unwrap();

for addr in addrs {
  println!("IPv4 Addr: {}", addr);
}

pub fn ipv4_addrs_by_filter<F>(&self, f: F) -> Result<SmallVec<Ifv4Net>>

where F: FnMut(&Ipv4Addr) -> bool,

Returns a list of unicast, IPv4 interface addrs for a specific interface. The filter is used to determine which multicast addresses to include.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv4_addrs_by_filter(|addr| {
  !addr.is_loopback()
}).unwrap();

for addr in addrs {
  println!("IPv4 Addr: {}", addr);
}

pub fn ipv6_addrs(&self) -> Result<SmallVec<Ifv6Net>>

Returns a list of unicast, IPv6 interface addrs for a specific interface.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv6_addrs().unwrap();

for addr in addrs {
  println!("IPv6 Addr: {}", addr);
}

pub fn ipv6_addrs_by_filter<F>(&self, f: F) -> Result<SmallVec<Ifv6Net>>

where F: FnMut(&Ipv6Addr) -> bool,

Returns a list of unicast, IPv6 interface addrs for a specific interface. The filter is used to determine which multicast addresses to include.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv6_addrs_by_filter(|addr| {
  !addr.is_loopback()
}).unwrap();

for addr in addrs {
  println!("IPv6 Addr: {}", addr);
}

pub fn multicast_addrs(&self) -> Result<SmallVec<IfAddr>>

Available on Apple or FreeBSD or Linux or Windows only.

Returns a list of multicast, joined group addrs for a specific interface.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.multicast_addrs().unwrap();

for addr in addrs {
  println!("Multicast Addr: {}", addr);
}

pub fn multicast_addrs_by_filter<F>(&self, f: F) -> Result<SmallVec<IfAddr>>

where F: FnMut(&IpAddr) -> bool,

Available on Apple or FreeBSD or Linux or Windows only.

Returns a list of multicast, joined group addrs for a specific interface. The filter is used to determine which multicast addresses to include.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.multicast_addrs_by_filter(|addr| {
  !addr.is_loopback()
}).unwrap();

for addr in addrs {
  println!("Multicast Addr: {}", addr);
}

pub fn ipv4_multicast_addrs(&self) -> Result<SmallVec<Ifv4Addr>>

Available on Apple or FreeBSD or Linux or Windows only.

Returns a list of multicast, joined group IPv4 addrs for a specific interface.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv4_multicast_addrs().unwrap();

for addr in addrs {
  println!("Multicast IPv4 Addr: {}", addr);
}

pub fn ipv4_multicast_addrs_by_filter<F>( &self, f: F, ) -> Result<SmallVec<Ifv4Addr>>

where F: FnMut(&Ipv4Addr) -> bool,

Available on Apple or FreeBSD or Linux or Windows only.

Returns a list of multicast, joined group IPv4 addrs for a specific interface. The filter is used to determine which multicast addresses to include.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv4_multicast_addrs_by_filter(|addr| {
  !addr.is_loopback()
}).unwrap();

for addr in addrs {
  println!("Multicast IPv4 Addr: {}", addr);
}

pub fn ipv6_multicast_addrs(&self) -> Result<SmallVec<Ifv6Addr>>

Available on Apple or FreeBSD or Linux or Windows only.

Returns a list of multicast, joined group IPv6 addrs for a specific interface.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv6_multicast_addrs().unwrap();

for addr in addrs {
  println!("Multicast IPv6 Addr: {}", addr);
}

pub fn ipv6_multicast_addrs_by_filter<F>( &self, f: F, ) -> Result<SmallVec<Ifv6Addr>>

where F: FnMut(&Ipv6Addr) -> bool,

Available on Apple or FreeBSD or Linux or Windows only.

Returns a list of multicast, joined group IPv6 addrs for a specific interface. The filter is used to determine which multicast addresses to include.

Example

use getifs::interfaces;

let interface = interfaces().unwrap().into_iter().next().unwrap();

let addrs = interface.ipv6_multicast_addrs_by_filter(|addr| {
  !addr.is_loopback()
}).unwrap();

for addr in addrs {
  println!("Multicast IPv6 Addr: {}", addr);
}

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Interface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interface

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

Formats the value using the given formatter.

impl Hash for Interface

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 PartialEq for Interface

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

impl StructuralPartialEq for Interface