docs: add some more docs to IR types

route_verification/ir/src/mp_import.rs

@@ -2,6 +2,7 @@ use itertools::chain;
 
 use super::*;
 
+/// Clustered by their IP versions, a collection of rule entries.
 #[derive(Clone, Default, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
 #[serde(default)]
 pub struct Versions {
@@ -48,6 +49,8 @@ impl std::fmt::Debug for Versions {
     }
 }
 
+/// Clustered by their cast types (unicast vs. multicast),
+/// a collection of rule entries.
 #[derive(Clone, Default, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
 #[serde(default)]
 pub struct Casts {
@@ -90,6 +93,8 @@ impl Casts {
     }
 }
 
+/// Representation of an RPSL rule entry, consisting of one or
+/// more `<mp-peering> [<actions>]` and a `<mp-filter>`.
 #[derive(Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
 pub struct Entry {
     #[serde(default)]

route_verification/ir/src/peering.rs

@@ -16,6 +16,7 @@ pub fn parse_single_as_expr(single: String) -> AsExpr {
     }
 }
 
+/// > ```ignore
 /// >  The syntax of a peering specification is:
 /// >
 /// >  <as-expression> [<router-expression-1>] [at <router-expression-2>]
@@ -37,6 +38,7 @@ pub fn parse_single_as_expr(single: String) -> AsExpr {
 /// >  local AS that peer with ASes in <as-expression>.  If <router-
 /// >  expression-1> is not specified, it defaults to all routers of the
 /// >  peer ASes in <as-expression> that peer with the local AS.
+/// > ```
 ///
 /// <https://www.rfc-editor.org/rfc/rfc2622#section-5.6>
 #[derive(Clone, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
@@ -66,6 +68,7 @@ impl std::fmt::Debug for Peering {
     }
 }
 
+/// Representation of `<mp-peering> [<actions>]` in an RPSL rule.
 #[derive(Clone, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
 pub struct PeeringAction {
     pub mp_peering: Peering,