Struct netstack3_device::BaseDeviceId

pub struct BaseDeviceId<T: DeviceStateSpec, BT: DeviceLayerTypes> { /* private fields */ }

A base device identifier.

Allows multiple device implementations to share the same shape for maintaining reference identifiers.

Implementations

impl<T: DeviceStateSpec, BT: DeviceLayerTypes> BaseDeviceId<T, BT>

pub fn device_state(&self, tracker: &OriginTracker) -> &IpLinkDeviceState<T, BT>

Returns a reference to the device state.

Requires an OriginTracker to ensure this is being access from the proper context and disallow usage in bindings.

pub fn external_state(&self) -> &T::External<BT>

Returns a reference to the external state for the device.

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

Returns the bindings identifier associated with the device.

pub fn downgrade(&self) -> BaseWeakDeviceId<T, BT>

Downgrades the ID to an EthernetWeakDeviceId.

Trait Implementations

impl<T: DeviceStateSpec, BT: DeviceLayerTypes> Clone for BaseDeviceId<T, BT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: DeviceStateSpec, BT: DeviceLayerTypes> Debug for BaseDeviceId<T, BT>

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

Formats the value using the given formatter.

impl<T: DeviceStateSpec, BT: DeviceLayerTypes> DeviceIdentifier for BaseDeviceId<T, BT>

fn is_loopback(&self) -> bool

Returns true if the device is a loopback device.

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<T: DeviceStateSpec, BT: DeviceLayerTypes> Hash for BaseDeviceId<T, BT>

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

where __HTBT: 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<T: DeviceStateSpec, BT: DeviceLayerTypes> Ord for BaseDeviceId<T, 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<T: DeviceStateSpec, BT: DeviceLayerTypes> PartialEq for BaseDeviceId<T, 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<T: DeviceStateSpec, BT: DeviceLayerTypes> PartialOrd for BaseDeviceId<T, 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<T: DeviceStateSpec, BT: DeviceLayerTypes> StrongDeviceIdentifier for BaseDeviceId<T, BT>

type Weak = BaseWeakDeviceId<T, BT>

The weak version of this identifier.

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

Returns a weak ID for this strong ID.

impl<T: DeviceStateSpec, BT: DeviceLayerTypes> Eq for BaseDeviceId<T, BT>