Struct Route

pub struct Route<I: Ip> {
    pub destination: Subnet<I::Addr>,
    pub action: RouteAction<I>,
    pub properties: RouteProperties,
}

A route, abstracting over fnet_routes::RouteV4 and fnet_routes::RouteV6.

The destination subnet is verified to be a valid subnet; e.g. its prefix-len is a valid value, and its host bits are cleared.

Fields

destination: Subnet<I::Addr>

The destination subnet of the route.

action: RouteAction<I>

The action specifying how to handle packets matching this route.

properties: RouteProperties

The additional properties of the route.

Implementations

impl<I: Ip> Route<I>

pub fn new_forward( destination: Subnet<I::Addr>, outbound_interface: u64, next_hop: Option<SpecifiedAddr<I::Addr>>, metric: SpecifiedMetric, ) -> Self

Constructs a new route with metric metric that forwards any packets to destination over outbound_interface.

pub fn new_forward_with_inherited_metric( destination: Subnet<I::Addr>, outbound_interface: u64, next_hop: Option<SpecifiedAddr<I::Addr>>, ) -> Self

Constructs a new route that forwards any packets to destination over outbound_interface, inheriting outbound_interface’s metric.

pub fn new_forward_with_explicit_metric( destination: Subnet<I::Addr>, outbound_interface: u64, next_hop: Option<SpecifiedAddr<I::Addr>>, metric: u32, ) -> Self

outbound_interface.

Trait Implementations

impl<I: Clone + Ip> Clone for Route<I>

where I::Addr: Clone,

fn clone(&self) -> Route<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug + Ip> Debug for Route<I>

where I::Addr: Debug,

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

Formats the value using the given formatter.

impl<I: Hash + Ip> Hash for Route<I>

where I::Addr: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

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: Ord + Ip> Ord for Route<I>

where I::Addr: Ord,

fn cmp(&self, other: &Route<I>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<I: PartialEq + Ip> PartialEq for Route<I>

where I::Addr: PartialEq,

fn eq(&self, other: &Route<I>) -> 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<I: PartialOrd + Ip> PartialOrd for Route<I>

where I::Addr: PartialOrd,

fn partial_cmp(&self, other: &Route<I>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I: Ip> TryFrom<Route<I>> for ForwardingEntry

type Error = NetTypeConversionError

The type returned in the event of a conversion error.

fn try_from(_: Route<I>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Route<Ipv4>> for RouteV4

type Error = NetTypeConversionError

The type returned in the event of a conversion error.

fn try_from(route: Route<Ipv4>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Route<Ipv6>> for RouteV6

type Error = NetTypeConversionError

The type returned in the event of a conversion error.

fn try_from(route: Route<Ipv6>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RouteV4> for Route<Ipv4>

type Error = FidlConversionError<RoutePropertiesRequiredFields>

The type returned in the event of a conversion error.

fn try_from(route: RouteV4) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RouteV6> for Route<Ipv6>

type Error = FidlConversionError<RoutePropertiesRequiredFields>

The type returned in the event of a conversion error.

fn try_from(route: RouteV6) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Copy + Ip> Copy for Route<I>

where I::Addr: Copy,

impl<I: Eq + Ip> Eq for Route<I>

where I::Addr: Eq,

impl<I: Ip> StructuralPartialEq for Route<I>