Struct netstack3_core::icmp::IcmpSocketId

pub struct IcmpSocketId<I, D, BT>(/* private fields */)
where
    I: IpExt,
    D: WeakDeviceIdentifier,
    BT: IcmpEchoBindingsTypes;

An ICMP socket.

Implementations

impl<I, D, BT> IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

pub fn debug_references(&self) -> impl Debug

Returns a means to debug outstanding references to this socket.

pub fn downgrade(&self) -> WeakIcmpSocketId<I, D, BT>

Downgrades this ID to a weak reference.

pub fn external_data(&self) -> &<BT as IcmpEchoBindingsTypes>::ExternalData<I>

Returns external data associated with this socket.

Trait Implementations

impl<I, D, BT> Borrow<Strong<ReferenceState<I, D, Icmp<BT>>>> for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

fn borrow(&self) -> &Strong<ReferenceState<I, D, Icmp<BT>>>

Immutably borrows from an owned value.

impl<I, D, BT> Clone for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

fn clone(&self) -> IcmpSocketId<I, D, BT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I, D, BT> Debug for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

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

Formats the value using the given formatter.

impl<I, D, BT> DelegatedOrderedLockAccess<SocketState<I, D, Icmp<BT>>> for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

type Inner = ReferenceState<I, D, Icmp<BT>>

The inner type acting as a proxy for ordered access to T.

fn delegate_ordered_lock_access( &self, ) -> &<IcmpSocketId<I, D, BT> as DelegatedOrderedLockAccess<SocketState<I, D, Icmp<BT>>>>::Inner

Returns the inner type.

impl<I, D, BT> From<Strong<ReferenceState<I, D, Icmp<BT>>>> for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

fn from(value: Strong<ReferenceState<I, D, Icmp<BT>>>) -> IcmpSocketId<I, D, BT>

Converts to this type from the input type.

impl<I, D, BT, IpType> GenericOverIp<IpType> for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes, IpType: Ip + IpExt,

type Type = IcmpSocketId<IpType, D, BT>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<I, D, BT> Hash for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

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

where __HIDBT: 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<I, D, BT> PartialEq<WeakIcmpSocketId<I, D, BT>> for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

fn eq(&self, other: &WeakIcmpSocketId<I, D, 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<I, D, BT> PartialEq for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

fn eq(&self, other: &IcmpSocketId<I, D, 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<I, D, BT> SocketMapAddrStateSpec for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,

type Id = IcmpSocketId<I, D, BT>

The type of ID that can be present at the address.

type SharingState = ()

The sharing state for the address.

type Inserter<'a> = Infallible where IcmpSocketId<I, D, BT>: 'a

The type of inserter returned by SocketMapAddrStateSpec::try_get_inserter.

fn new( _new_sharing_state: &<IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::SharingState, id: <IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::Id, ) -> IcmpSocketId<I, D, BT>

Creates a new Self holding the provided socket with the given new sharing state at the specified address.

fn contains_id( &self, id: &<IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::Id, ) -> bool

Looks up the ID in self, returning true if it is present.

fn try_get_inserter<'a, 'b>( &'b mut self, _new_sharing_state: &'a <IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::SharingState, ) -> Result<<IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::Inserter<'b>, IncompatibleError>

Enables insertion in self for a new socket with the provided sharing state.

fn could_insert( &self, _new_sharing_state: &<IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::SharingState, ) -> Result<(), IncompatibleError>

Returns Ok if an entry with the given sharing state could be added to self.

fn remove_by_id( &mut self, _id: <IcmpSocketId<I, D, BT> as SocketMapAddrStateSpec>::Id, ) -> RemoveResult

Removes the given socket from the existing state.

impl<I, D, BT> Eq for IcmpSocketId<I, D, BT>

where I: IpExt, D: WeakDeviceIdentifier, BT: IcmpEchoBindingsTypes,