Struct net_route::Route

pub struct Route {
    pub destination: IpAddr,
    pub prefix: u8,
    pub gateway: Option<IpAddr>,
    pub ifindex: Option<u32>,
    pub table: u8,
    pub source: Option<IpAddr>,
    pub source_prefix: u8,
    pub source_hint: Option<IpAddr>,
    pub metric: Option<u32>,
}

Contains information that describes a route in the local computer’s Ipv4 or Ipv6 routing table.

Fields

destination: IpAddr

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

prefix: u8

Length of network prefix in the destination address.

gateway: Option<IpAddr>

The address of the next hop of this route.

On macOS, this must be Some if ifindex is None

ifindex: Option<u32>

The index of the local interface through which the next hop of this route may be reached.

On macOS, this must be Some if gateway is None

table: u8

The routing table this route belongs to.

source: Option<IpAddr>

Network address of the source.

source_prefix: u8

Prefix length of the source address.

source_hint: Option<IpAddr>

Source address hint. Does not influence routing.

metric: Option<u32>

The route metric offset value for this route.

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 with_gateway(self, gateway: IpAddr) -> Self

Set the next next hop gateway for this route.

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

Set the index of the local interface through which the next hop of this route should be reached.

pub fn with_table(self, table: u8) -> Self

Set table the route will be installed in.

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

Set source.

pub fn with_source_hint(self, hint: IpAddr) -> Self

Set source hint.

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

Set route metric.

pub fn mask(&self) -> IpAddr

Get the netmask covering the network portion of the destination address.

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 PartialEq for Route

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

impl StructuralPartialEq for Route