Skip to main content

NeighborEntry

Struct NeighborEntry 

Source
#[non_exhaustive]
pub struct NeighborEntry { pub id: Id<NeighborEntry>, pub interface_index: u32, pub address: IpAddress, pub mac: Option<MacAddress>, pub state: NeighborState, }
Expand description

A single entry in the system’s neighbor table (ARP for IPv4, NDP for IPv6): the mapping from an on-link IP address to a link-layer (MAC) address, as observed or configured on a given interface.

#[non_exhaustive]: platforms carry different neighbor fields (Linux exposes NUD state and a routing-protocol-style entry kind; BSD/macOS expose only a flags word; Windows exposes IsRouter/reachability timestamps). Marking this non-exhaustive now means adding platform-specific fields later is not a breaking change for consumers who construct a NeighborEntry via NeighborEntry::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<NeighborEntry>§interface_index: u32

The OS-level interface index this entry was observed on, the same raw value Interface::index/Route::interface_index carry.

§address: IpAddress§mac: Option<MacAddress>

Absent for an entry still being resolved (NeighborState::Incomplete) or one the platform reports without a link-layer address at all.

§state: NeighborState

Implementations§

Source§

impl NeighborEntry

Source

pub fn new( id: Id<NeighborEntry>, interface_index: u32, address: IpAddress, ) -> NeighborEntry

Source

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

Source

pub fn with_state(self, state: NeighborState) -> NeighborEntry

Trait Implementations§

Source§

impl Clone for NeighborEntry

Source§

fn clone(&self) -> NeighborEntry

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 NeighborEntry

Source§

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

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

impl Eq for NeighborEntry

Source§

impl Hash for NeighborEntry

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 NeighborEntry

Source§

fn eq(&self, other: &NeighborEntry) -> 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 NeighborEntry

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.