Struct Route

pub struct Route {
    pub destination: IpAddr,
    pub prefix: u8,
    pub gateway: IpAddr,
    pub ifindex: Option<u32>,
    pub metric: Option<u32>,
    pub luid: Option<u64>,
    pub version: u8,
}

Routing data structure, including destination address, gateway and other information

Fields

destination: IpAddr

Network address of the destination. 0.0.0.0 with a prefix of 0 is considered a default route.

prefix: u8

Prefix for the destination IP address of this route.

gateway: IpAddr

The address of the next hop

ifindex: Option<u32>

The local index value for the network interface associated with this IP route entry.

metric: Option<u32>

The route metric offset value for this IP route entry.

luid: Option<u64>

The locally unique identifier (LUID) for the network interface associated with this IP route entry.

version: u8

The IP version number, the value is 4 or 6

Implementations

impl Route

pub fn new(destination: IpAddr, prefix: u8) -> Self

Create a route that matches a given destination network.

Either the gateway or interface should be set before attempting to add to a routing table.

pub fn destination(self, destination: IpAddr) -> Self

destination setter

pub fn prefix(self, prefix: u8) -> Self

prefix setter

pub fn gateway(self, gateway: IpAddr) -> Self

gateway setter

pub fn ifindex(self, idx: u32) -> Self

ifindex setter

pub fn metric(self, metric: u32) -> Self

metric setter

pub fn luid(self, luid: u64) -> Self

luic setter

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Route

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Route

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

Formats the value using the given formatter.

impl PartialEq for Route

fn eq(&self, other: &Route) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Route

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Route

impl StructuralPartialEq for Route