Enum netstack3_device::DeviceId

pub enum DeviceId<BT: DeviceLayerTypes> {
    Ethernet(EthernetDeviceId<BT>),
    Loopback(LoopbackDeviceId<BT>),
    PureIp(PureIpDeviceId<BT>),
}

A strong ID identifying a device.

Holders may safely assume that the underlying device is “alive” in the sense that the device is still recognized by the stack. That is, operations that use this device ID will never fail as a result of “unrecognized device”-like errors.

Variants

Ethernet(EthernetDeviceId<BT>)

Loopback(LoopbackDeviceId<BT>)

PureIp(PureIpDeviceId<BT>)

Implementations

impl<BT: DeviceLayerTypes> DeviceId<BT>

pub fn downgrade(&self) -> WeakDeviceId<BT>

Downgrade to a WeakDeviceId.

pub fn bindings_id(&self) -> &BT::DeviceIdentifier

Returns the bindings identifier associated with the device.

Trait Implementations

impl<BT: DeviceLayerTypes> Clone for DeviceId<BT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BT: DeviceLayerTypes> Debug for DeviceId<BT>

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

Formats the value using the given formatter.

impl<BT: DeviceLayerTypes> DeviceIdentifier for DeviceId<BT>

fn is_loopback(&self) -> bool

Returns true if the device is a loopback device.

impl<BT: DeviceLayerTypes> DeviceWithName for DeviceId<BT>

fn name_matches(&self, name: &str) -> bool

Returns whether the provided name matches the interface.

impl<BT: DeviceLayerTypes> From<BaseDeviceId<EthernetLinkDevice, BT>> for DeviceId<BT>

fn from(id: EthernetDeviceId<BT>) -> DeviceId<BT>

Converts to this type from the input type.

impl<BT: DeviceLayerTypes> From<BaseDeviceId<LoopbackDevice, BT>> for DeviceId<BT>

fn from(id: LoopbackDeviceId<BT>) -> DeviceId<BT>

Converts to this type from the input type.

impl<BT: DeviceLayerTypes> From<BaseDeviceId<PureIpDevice, BT>> for DeviceId<BT>

fn from(id: PureIpDeviceId<BT>) -> DeviceId<BT>

Converts to this type from the input type.

impl<BT: DeviceLayerTypes> Hash for DeviceId<BT>

fn hash<__HBT>(&self, __state: &mut __HBT)

where __HBT: Hasher,

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<BT: DeviceLayerTypes> InterfaceProperties<<BT as FilterBindingsTypes>::DeviceClass> for DeviceId<BT>

fn id_matches(&self, id: &NonZeroU64) -> bool

Returns whether the provided ID matches the interface.

fn device_class_matches(&self, device_class: &BT::DeviceClass) -> bool

Returns whether the provided device class matches the interface.

impl<BT: DeviceLayerTypes> Ord for DeviceId<BT>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<BT: DeviceLayerTypes> PartialEq<DeviceId<BT>> for WeakDeviceId<BT>

fn eq(&self, other: &DeviceId<BT>) -> 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<BT: DeviceLayerTypes> PartialEq<WeakDeviceId<BT>> for DeviceId<BT>

fn eq(&self, other: &WeakDeviceId<BT>) -> 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<BT: DeviceLayerTypes> PartialEq for DeviceId<BT>

fn eq(&self, other: &Self) -> 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<BT: DeviceLayerTypes> PartialOrd for DeviceId<BT>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<BT: DeviceLayerTypes> StrongDeviceIdentifier for DeviceId<BT>

type Weak = WeakDeviceId<BT>

The weak version of this identifier.

fn downgrade(&self) -> Self::Weak

Returns a weak ID for this strong ID.

impl<BT: DeviceLayerTypes> Eq for DeviceId<BT>