Struct nmstate::RouteEntry

#[non_exhaustive]
pub struct RouteEntry {
    pub state: Option<RouteState>,
    pub destination: Option<String>,
    pub next_hop_iface: Option<String>,
    pub next_hop_addr: Option<String>,
    pub metric: Option<i64>,
    pub table_id: Option<u32>,
    pub weight: Option<u16>,
    pub route_type: Option<RouteType>,
    pub cwnd: Option<u32>,
}

Route entry

Fields (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.

state: Option<RouteState>

Only used for delete route when applying.

destination: Option<String>

Route destination address or network Mandatory for every non-absent routes.

next_hop_iface: Option<String>

Route next hop interface name. Serialize and deserialize to/from next-hop-interface. Mandatory for every non-absent routes except for route with route type Blackhole, Unreachable, Prohibit.

next_hop_addr: Option<String>

Route next hop IP address. Serialize and deserialize to/from next-hop-address. When setting this as empty string for absent route, it will only delete routes without next-hop-address.

metric: Option<i64>

Route metric. RouteEntry::USE_DEFAULT_METRIC for default setting of network backend.

table_id: Option<u32>

Route table id. RouteEntry::USE_DEFAULT_ROUTE_TABLE for main route table 254.

weight: Option<u16>

ECMP(Equal-Cost Multi-Path) route weight The valid range of this property is 1-256.

route_type: Option<RouteType>

Route type Serialize and deserialize to/from route-type.

cwnd: Option<u32>

Congestion window clamp

Implementations

impl RouteEntry

pub const USE_DEFAULT_METRIC: i64 = -1i64

pub const USE_DEFAULT_ROUTE_TABLE: u32 = 0u32

pub fn new() -> Self

Trait Implementations

impl Clone for RouteEntry

fn clone(&self) -> RouteEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteEntry

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

Formats the value using the given formatter.

impl Default for RouteEntry

fn default() -> RouteEntry

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RouteEntry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RouteEntry

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

Formats the value using the given formatter.

impl Hash for RouteEntry

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 Ord for RouteEntry

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RouteEntry

fn eq(&self, other: &Self) -> 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 PartialOrd for RouteEntry

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for RouteEntry

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 RouteEntry