Struct nmstate::Routes

#[non_exhaustive]
pub struct Routes {
    pub running: Option<Vec<RouteEntry>>,
    pub config: Option<Vec<RouteEntry>>,
}

IP routing status

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.

running: Option<Vec<RouteEntry>>

Running effected routes containing route from universe or link scope, and only from these protocols:

• boot (often used by iproute command)
• static
• ra
• dhcp
• mrouted
• keepalived
• babel

Ignored when applying.

config: Option<Vec<RouteEntry>>

Static routes containing route from universe or link scope, and only from these protocols:

• boot (often used by iproute command)
• static

When applying, None means preserve current routes. This property is not overriding but adding specified routes to existing routes. To delete a route entry, please [RouteEntry.state] as RouteState::Absent. Any property of absent RouteEntry set to None means wildcard. For example, this crate::NetworkState could remove all routes next hop to interface eth1(showing in yaml):

routes:
  config:
  - next-hop-interface: eth1
    state: absent

To change a route entry, you need to delete old one and add new one(can be in single transaction).

Implementations

impl Routes

pub fn new() -> Self

pub fn is_empty(&self) -> bool

TODO: hide it, internal only

pub fn validate(&self) -> Result<(), NmstateError>

Trait Implementations

impl Clone for Routes

fn clone(&self) -> Routes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Routes

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

Formats the value using the given formatter.

impl Default for Routes

fn default() -> Routes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Routes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Routes> for Routes

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

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 Routes

impl StructuralEq for Routes

impl StructuralPartialEq for Routes