Skip to main content

Interface

Struct Interface 

Source
#[non_exhaustive]
pub struct Interface { pub id: Id<Interface>, pub index: u32, pub name: String, pub kind: InterfaceKind, pub mac: Option<MacAddress>, pub mtu: Option<u32>, pub admin_state: AdminState, pub operational_state: OperationalState, }
Expand description

A network interface.

#[non_exhaustive]: platforms carry different interface fields (Linux exposes carrier, txqueuelen, type; Windows exposes MediaType, OperationalStatus; BSD/macOS expose a combined flags word). Marking this non-exhaustive now means adding platform-specific fields later is not a breaking change for consumers who construct an Interface via Interface::new rather than a struct literal — see ARCHITECTURE.md’s note on model extensibility.

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: Id<Interface>§index: u32

The OS-level interface index (ifindex on Linux, InterfaceIndex on Windows, if_index on BSD/macOS). This is the same raw value Route::interface_index carries — kept here as the canonical home now that the interface domain exists (Stage 0.4).

§name: String§kind: InterfaceKind§mac: Option<MacAddress>§mtu: Option<u32>§admin_state: AdminState§operational_state: OperationalState

Implementations§

Source§

impl Interface

Source

pub fn new( id: Id<Interface>, index: u32, name: impl Into<String>, kind: InterfaceKind, ) -> Interface

Source

pub fn with_mac(self, mac: MacAddress) -> Interface

Source

pub fn with_mtu(self, mtu: u32) -> Interface

Source

pub fn with_admin_state(self, state: AdminState) -> Interface

Source

pub fn with_operational_state(self, state: OperationalState) -> Interface

Trait Implementations§

Source§

impl Clone for Interface

Source§

fn clone(&self) -> Interface

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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<(), Error>

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

impl Eq for Interface

Source§

impl Hash for Interface

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Interface

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Interface

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.