Docs for existing tc-actions

Author: daniel-noland

src/tc/actions/mirror.rs

@@ -14,21 +14,27 @@ use netlink_packet_utils::{
 
 use super::{TcActionGeneric, TcActionGenericBuffer};
 
+/// Traffic control action used to mirror or redirect packets.
 #[derive(Debug, PartialEq, Eq, Clone)]
 #[non_exhaustive]
 pub struct TcActionMirror {}
 impl TcActionMirror {
+    /// The `TcActionAttribute::Kind` of this action.
     pub const KIND: &'static str = "mirred";
 }
 
 const TCA_MIRRED_TM: u16 = 1;
 const TCA_MIRRED_PARMS: u16 = 2;
 
+/// Options for the `TcActionMirror` action.
 #[derive(Debug, PartialEq, Eq, Clone)]
 #[non_exhaustive]
 pub enum TcActionMirrorOption {
+    /// TODO: document this after we make it something better than `Vec<u8>`
     Tm(Vec<u8>),
+    /// Parameters for the mirred action.
     Parms(TcMirror),
+    /// Other attributes unknown at the time of writing.
     Other(DefaultNla),
 }
 
@@ -74,11 +80,15 @@ impl<'a, T: AsRef<[u8]> + ?Sized> Parseable<NlaBuffer<&'a T>>
 
 const TC_MIRRED_BUF_LEN: usize = TcActionGeneric::BUF_LEN + 8;
 
+/// Parameters for the mirred action.
 #[derive(Debug, PartialEq, Eq, Clone, Default)]
 #[non_exhaustive]
 pub struct TcMirror {
+    /// Generic action parameters.
     pub generic: TcActionGeneric,
+    /// Describes how the packet be mirrored or redirected.
     pub eaction: TcMirrorActionType,
+    /// Interface index to mirror or redirect to.
     pub ifindex: u32,
 }
 
@@ -121,14 +131,20 @@ const TCA_EGRESS_MIRROR: i32 = 2;
 const TCA_INGRESS_REDIR: i32 = 3;
 const TCA_INGRESS_MIRROR: i32 = 4;
 
+/// Type of mirroring or redirecting action.
 #[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
 #[non_exhaustive]
 pub enum TcMirrorActionType {
     #[default]
+    /// Redirect to the egress pipeline.
     EgressRedir,
+    /// Mirror to the egress pipeline.
     EgressMirror,
+    /// Redirect to the ingress pipeline.
     IngressRedir,
+    /// Mirror to the ingress pipeline.
     IngressMirror,
+    /// Other action type unknown at the time of writing.
     Other(i32),
 }
 

src/tc/actions/nat.rs

@@ -16,6 +16,7 @@ use super::{nat_flag::TcNatFlags, TcActionGeneric, TcActionGenericBuffer};
 const TCA_NAT_PARMS: u16 = 1;
 const TCA_NAT_TM: u16 = 2;
 
+/// Network address translation action.
 #[derive(Debug, PartialEq, Eq, Clone)]
 #[non_exhaustive]
 pub struct TcActionNat {}
@@ -24,11 +25,15 @@ impl TcActionNat {
     pub(crate) const KIND: &'static str = "nat";
 }
 
+/// Options for the [`TcActionNat`] action.
 #[derive(Debug, PartialEq, Eq, Clone)]
 #[non_exhaustive]
 pub enum TcActionNatOption {
+    /// > TODO: document this after we make it something better than `Vec<u8>`
     Tm(Vec<u8>),
+    /// Parameters for the nat action.
     Parms(TcNat),
+    /// Other attributes unknown at the time of writing.
     Other(DefaultNla),
 }
 
@@ -74,13 +79,19 @@ impl<'a, T: AsRef<[u8]> + ?Sized> Parseable<NlaBuffer<&'a T>>
 
 const TC_NAT_BUF_LEN: usize = TcActionGeneric::BUF_LEN + 16;
 
+/// Network address translation action.
 #[derive(Debug, PartialEq, Eq, Clone)]
 #[non_exhaustive]
 pub struct TcNat {
+    /// Common attributes for all actions.
     pub generic: TcActionGeneric,
+    /// Original address.
     pub old_addr: Ipv4Addr,
+    /// New address.
     pub new_addr: Ipv4Addr,
+    /// Mask of the old address
     pub mask: Ipv4Addr,
+    /// Flags for the NAT action.
     pub flags: TcNatFlags,
 }
 

src/tc/actions/nat_flag.rs

@@ -9,6 +9,7 @@ const TCA_ACT_FLAGS_NO_RTNL: u32 = 1u32 << (TCA_ACT_FLAGS_USER_BITS + 3);
 const TCA_ACT_FLAGS_AT_INGRESS: u32 = 1u32 << (TCA_ACT_FLAGS_USER_BITS + 4);
 
 bitflags! {
+    /// Network Address Translation flags.
     #[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
     #[non_exhaustive]
     pub struct TcNatFlags: u32 {