Skip to main content

Route

Struct Route 

Source
#[non_exhaustive]
pub struct Route { pub id: Id<Route>, pub destination: Network, pub gateway: Option<IpAddress>, pub metric: Option<u32>, pub interface_index: Option<u32>, }
Expand description

A single routing table entry.

#[non_exhaustive]: platforms carry different route fields (Linux adds table/protocol/scope/type on top of destination/gateway/metric; Windows and BSD expose a narrower set — see ARCHITECTURE.md’s note on model extensibility). Marking this non-exhaustive now means adding platform-specific fields later is not a breaking change for consumers who construct a Route via Route::new rather than a struct literal.

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<Route>§destination: Network§gateway: Option<IpAddress>§metric: Option<u32>§interface_index: Option<u32>

The outgoing interface, identified by its raw OS-level index.

This is a raw u32 rather than a typed InterfaceId because the interface domain module doesn’t exist yet (it lands in Stage 0.4 per ARCHITECTURE.md’s Incremental Delivery Plan) — Route shouldn’t block on it just to express what the kernel already gives us directly. Many routes are ambiguous or outright rejected by the kernel without an explicit output interface (on-link routes, multiple interfaces on the same subnet), so this isn’t optional polish: without it, a meaningful fraction of real routes can’t be added at all.

Implementations§

Source§

impl Route

Source

pub fn new(id: Id<Route>, destination: Network) -> Route

Source

pub fn with_gateway(self, gateway: IpAddress) -> Route

Source

pub fn with_metric(self, metric: u32) -> Route

Source

pub fn with_interface_index(self, interface_index: u32) -> Route

Trait Implementations§

Source§

impl Clone for Route

Source§

fn clone(&self) -> Route

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 Route

Source§

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

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

impl Eq for Route

Source§

impl Hash for Route

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 Route

Source§

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

Auto Trait Implementations§

§

impl Freeze for Route

§

impl RefUnwindSafe for Route

§

impl Send for Route

§

impl Sync for Route

§

impl Unpin for Route

§

impl UnsafeUnpin for Route

§

impl UnwindSafe for Route

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.