Skip to main content

Interface

Struct Interface 

Source
#[non_exhaustive]
pub struct Interface { pub id: InterfaceId, pub name: String, pub interface_type: InterfaceType, pub is_up: bool, pub addresses: Vec<IpAddr>, pub mac: Option<[u8; 6]>, pub signal_strength: Option<u8>, pub link_speed_mbps: Option<u32>, pub is_metered: bool, }
Expand description

Network interface descriptor.

Tier: T2-C (Σ + μ + ∃ + ς — typed, mapped, existent, stateful)

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: InterfaceId

Unique interface ID.

§name: String

Human-readable name (e.g., “wlan0”, “eth0”).

§interface_type: InterfaceType

Interface type.

§is_up: bool

Whether the interface is currently up.

§addresses: Vec<IpAddr>

Assigned IP addresses.

§mac: Option<[u8; 6]>

Hardware (MAC) address, if available.

§signal_strength: Option<u8>

Signal strength (0-100), if applicable.

§link_speed_mbps: Option<u32>

Link speed in Mbps, if known.

§is_metered: bool

Whether this interface is metered.

Implementations§

Source§

impl Interface

Source

pub fn new( id: impl Into<String>, name: impl Into<String>, interface_type: InterfaceType, ) -> Self

Create a new interface.

Source

pub fn up(self) -> Self

Builder: set the interface as up.

Source

pub fn with_address(self, addr: IpAddr) -> Self

Builder: add an IP address.

Source

pub fn with_mac(self, mac: [u8; 6]) -> Self

Builder: set MAC address.

Source

pub fn with_signal(self, strength: u8) -> Self

Builder: set signal strength.

Source

pub fn with_speed(self, mbps: u32) -> Self

Builder: set link speed.

Source

pub fn has_address(&self) -> bool

Whether this interface has any usable address.

Source

pub fn is_ready(&self) -> bool

Whether this interface is ready for traffic.

Source

pub fn primary_address(&self) -> Option<&IpAddr>

Get the primary (first) address.

Source

pub fn effective_priority(&self) -> u16

Effective routing priority (lower = preferred).

Trait Implementations§

Source§

impl Clone for Interface

Source§

fn clone(&self) -> Interface

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Interface

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Interface

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Interface

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,