Struct ipconfig::Adapter

pub struct Adapter { /* private fields */ }

Represent an adapter.

Implementations

impl Adapter

pub fn adapter_name(&self) -> &str

Get the adapter’s name

pub fn ip_addresses(&self) -> &[IpAddr]

Get the adapter’s ip addresses (unicast ip addresses)

Examples found in repository

examples/priority_list.rs (line 9)

fn main() {
    let mut adapters = ipconfig::get_adapters().unwrap();
    adapters.sort_by(|ip1, ip2| ip1.ipv4_metric().cmp(&ip2.ipv4_metric()));
    for adapter in adapters {
        println!(
            "{}: IfType: {:?}  IPs: {:?} - IPv4 metric: {} IPv6 metric: {}",
            adapter.friendly_name(),
            adapter.if_type(),
            adapter.ip_addresses(),
            adapter.ipv4_metric(),
            adapter.ipv6_metric()
        )
    }
}

pub fn prefixes(&self) -> &[(IpAddr, u32)]

Get the adapter’s prefixes. Returns a list of tuples (IpAddr, u32), where first element is a subnet address, e.g. 192.168.1.0 and second element is prefix length, e.g. 24

pub fn gateways(&self) -> &[IpAddr]

Get the adapter’s gateways

pub fn dns_servers(&self) -> &[IpAddr]

Get the adapter’s dns servers (the preferred dns server is first)

pub fn description(&self) -> &str

Get the adapter’s description

pub fn friendly_name(&self) -> &str

Get the adapter’s friendly name

Examples found in repository

examples/priority_list.rs (line 7)

fn main() {
    let mut adapters = ipconfig::get_adapters().unwrap();
    adapters.sort_by(|ip1, ip2| ip1.ipv4_metric().cmp(&ip2.ipv4_metric()));
    for adapter in adapters {
        println!(
            "{}: IfType: {:?}  IPs: {:?} - IPv4 metric: {} IPv6 metric: {}",
            adapter.friendly_name(),
            adapter.if_type(),
            adapter.ip_addresses(),
            adapter.ipv4_metric(),
            adapter.ipv6_metric()
        )
    }
}

pub fn physical_address(&self) -> Option<&[u8]>

Get the adapter’s physical (MAC) address

pub fn receive_link_speed(&self) -> u64

Get the adapter Recieve Link Speed (bits per second)

pub fn transmit_link_speed(&self) -> u64

Get the Trasnmit Link Speed (bits per second)

pub fn oper_status(&self) -> OperStatus

Check if the adapter is up (OperStatus is IfOperStatusUp)

pub fn if_type(&self) -> IfType

Get the interface type

Examples found in repository

examples/priority_list.rs (line 8)

fn main() {
    let mut adapters = ipconfig::get_adapters().unwrap();
    adapters.sort_by(|ip1, ip2| ip1.ipv4_metric().cmp(&ip2.ipv4_metric()));
    for adapter in adapters {
        println!(
            "{}: IfType: {:?}  IPs: {:?} - IPv4 metric: {} IPv6 metric: {}",
            adapter.friendly_name(),
            adapter.if_type(),
            adapter.ip_addresses(),
            adapter.ipv4_metric(),
            adapter.ipv6_metric()
        )
    }
}

pub fn ipv6_if_index(&self) -> u32

Get the IPv6 interface index.

The return value can be used as an IPv6 scope id for link-local addresses.

pub fn ipv4_metric(&self) -> u32

Returns the metric used to compute route preference for IPv4

Examples found in repository

examples/priority_list.rs (line 3)

fn main() {
    let mut adapters = ipconfig::get_adapters().unwrap();
    adapters.sort_by(|ip1, ip2| ip1.ipv4_metric().cmp(&ip2.ipv4_metric()));
    for adapter in adapters {
        println!(
            "{}: IfType: {:?}  IPs: {:?} - IPv4 metric: {} IPv6 metric: {}",
            adapter.friendly_name(),
            adapter.if_type(),
            adapter.ip_addresses(),
            adapter.ipv4_metric(),
            adapter.ipv6_metric()
        )
    }
}

pub fn ipv6_metric(&self) -> u32

Returns the metric used to compute route preference for IPv6

Examples found in repository

examples/priority_list.rs (line 11)

fn main() {
    let mut adapters = ipconfig::get_adapters().unwrap();
    adapters.sort_by(|ip1, ip2| ip1.ipv4_metric().cmp(&ip2.ipv4_metric()));
    for adapter in adapters {
        println!(
            "{}: IfType: {:?}  IPs: {:?} - IPv4 metric: {} IPv6 metric: {}",
            adapter.friendly_name(),
            adapter.if_type(),
            adapter.ip_addresses(),
            adapter.ipv4_metric(),
            adapter.ipv6_metric()
        )
    }
}

Trait Implementations

impl Debug for Adapter

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

Formats the value using the given formatter.