Enum nmstate::Interface

#[non_exhaustive]
pub enum Interface {
    Bond(BondInterface),
    Dummy(DummyInterface),
    Ethernet(EthernetInterface),
    Hsr(HsrInterface),
    LinuxBridge(LinuxBridgeInterface),
    OvsBridge(OvsBridgeInterface),
    OvsInterface(OvsInterface),
    Unknown(UnknownInterface),
    Vlan(VlanInterface),
    Vxlan(VxlanInterface),
    MacVlan(MacVlanInterface),
    MacVtap(MacVtapInterface),
    Vrf(VrfInterface),
    InfiniBand(InfiniBandInterface),
    Loopback(LoopbackInterface),
    MacSec(MacSecInterface),
    Ipsec(IpsecInterface),
    Xfrm(XfrmInterface),
}

Represent a kernel or user space network interface.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bond(BondInterface)

Bond interface

Dummy(DummyInterface)

Dummy interface.

Ethernet(EthernetInterface)

Ethernet interface or virtual ethernet(veth) of linux kernel

Hsr(HsrInterface)

HSR interface provided by Linux kernel.

LinuxBridge(LinuxBridgeInterface)

Bridge provided by Linux kernel.

OvsBridge(OvsBridgeInterface)

OpenvSwitch bridge.

OvsInterface(OvsInterface)

OpenvSwitch system interface.

Unknown(UnknownInterface)

Unknown interface.

Vlan(VlanInterface)

VLAN interface.

Vxlan(VxlanInterface)

VxLAN interface.

MacVlan(MacVlanInterface)

MAC VLAN interface.

MacVtap(MacVtapInterface)

MAC VTAP interface.

Vrf(VrfInterface)

Virtual Routing and Forwarding interface

InfiniBand(InfiniBandInterface)

IP over InfiniBand interface

Loopback(LoopbackInterface)

Linux loopback interface

MacSec(MacSecInterface)

MACsec interface.

Ipsec(IpsecInterface)

Ipsec connection

Xfrm(XfrmInterface)

Linux xfrm interface

Implementations

impl Interface

pub fn name(&self) -> &str

The interface name.

pub fn iface_type(&self) -> InterfaceType

The interface type

pub fn is_up(&self) -> bool

Whether interface is up, default to true.

pub fn is_absent(&self) -> bool

Whether interface is marked as absent.

pub fn is_down(&self) -> bool

Whether interface is marked as down.

pub fn is_ignore(&self) -> bool

Whether interface is marked as ignore.

pub fn is_virtual(&self) -> bool

Whether interface is virtual(can delete from kernel). Since loopback interface should not be deleted from system, hence we consider loopback interface as not virtual interface. Unknown interface is considered as not virtual interface.

pub fn need_controller(&self) -> bool

Whether current interface only lives when its control exists. For example, OpenvSwitch system interface can only exists when its controller OpenvSwitch bridge exists.

pub fn base_iface(&self) -> &BaseInterface

Get reference of its BaseInterface.

pub fn base_iface_mut(&mut self) -> &mut BaseInterface

pub fn ports(&self) -> Option<Vec<&str>>

The name of ports. Return None if its is not controller or not mentioned port section

impl Interface

pub fn update(&mut self, other: &Interface)

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Interface

Returns a copy 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 Default for Interface

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Interface

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Interface

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Interface

impl StructuralPartialEq for Interface