Struct RuleMessage 

#[non_exhaustive]
pub struct RuleMessage { /* private fields */ }

Strongly-typed routing rule message with all attributes parsed.

Fields are pub(crate); consumers read via the per-field accessor methods (see Self::priority, Self::source, etc.). The struct is #[non_exhaustive] so the kernel can grow new attribute fields without it being a breaking change.

Implementations

impl RuleMessage

pub fn new() -> Self

Create a new empty rule message.

pub fn family(&self) -> u8

Get the address family as the raw AF_* byte (kernel wire form).

pub fn family_typed(&self) -> AddressFamily

Get the address family as a typed crate::AddressFamily (Plan 227).

Prefer this over the raw Self::family in new code — the typed form lets the caller compare against AddressFamily::v4() / AddressFamily::v6() without remembering AF_* magic numbers, and gracefully exposes unmodelled bytes via crate::AddressFamily::is_known.

pub fn is_ipv4(&self) -> bool

Check if this is an IPv4 rule.

pub fn is_ipv6(&self) -> bool

Check if this is an IPv6 rule.

pub fn src_len(&self) -> u8

Get the source prefix length.

pub fn dst_len(&self) -> u8

Get the destination prefix length.

pub fn action(&self) -> FibRuleAction

Get the rule action.

pub fn is_lookup(&self) -> bool

Check if this is a table lookup rule.

pub fn is_blackhole(&self) -> bool

Check if this is a blackhole rule.

pub fn is_unreachable(&self) -> bool

Check if this is an unreachable rule.

pub fn is_prohibit(&self) -> bool

Check if this is a prohibit rule.

pub fn table_id(&self) -> u32

Get the routing table ID.

pub fn is_default(&self) -> bool

Check if this is a default rule (priority 0, 32766, or 32767).

pub fn priority(&self) -> u32

Rule priority (FRA_PRIORITY). Returns 0 when the kernel did not set the attribute.

pub fn source(&self) -> Option<IpAddr>

Source address (FRA_SRC), if present.

pub fn destination(&self) -> Option<IpAddr>

Destination address (FRA_DST), if present.

pub fn iifname(&self) -> Option<&str>

Input interface name (FRA_IIFNAME), if present.

pub fn oifname(&self) -> Option<&str>

Output interface name (FRA_OIFNAME), if present.

pub fn fwmark(&self) -> Option<u32>

Firewall mark (FRA_FWMARK), if present.

pub fn fwmask(&self) -> Option<u32>

Firewall mark mask (FRA_FWMASK), if present.

pub fn table(&self) -> u32

Routing table ID. Returns the 32-bit FRA_TABLE override when present, else the 8-bit header.table.

pub fn goto(&self) -> Option<u32>

Goto target rule priority (FRA_GOTO), if present.

pub fn flow(&self) -> Option<u32>

Flow classification ID (FRA_FLOW), if present.

pub fn tun_id(&self) -> Option<u64>

Tunnel ID (FRA_TUN_ID), if present.

pub fn suppress_ifgroup(&self) -> Option<u32>

Suppress interface group (FRA_SUPPRESS_IFGROUP), if present.

pub fn suppress_prefixlen(&self) -> Option<u32>

Suppress prefix length (FRA_SUPPRESS_PREFIXLEN), if present.

pub fn l3mdev(&self) -> Option<u8>

L3 master device flag (FRA_L3MDEV), if present.

pub fn uid_range(&self) -> Option<FibRuleUidRange>

UID range (FRA_UID_RANGE), if present.

pub fn protocol(&self) -> Option<u8>

Rule protocol (FRA_PROTOCOL), if present.

pub fn ip_proto(&self) -> Option<u8>

IP protocol for port matching (FRA_IP_PROTO), if present.

pub fn sport_range(&self) -> Option<FibRulePortRange>

Source port range (FRA_SPORT_RANGE), if present.

pub fn dport_range(&self) -> Option<FibRulePortRange>

Destination port range (FRA_DPORT_RANGE), if present.

Trait Implementations

impl Clone for RuleMessage

fn clone(&self) -> RuleMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleMessage

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

Formats the value using the given formatter.

impl Default for RuleMessage

fn default() -> RuleMessage

Returns the “default value” for a type.

impl FromNetlink for RuleMessage

fn write_dump_header(buf: &mut Vec<u8>)

Write the header required for dump requests. This is appended to the netlink message after the nlmsghdr. Default implementation writes nothing (for messages that don’t need a header).

fn parse(input: &mut &[u8]) -> PResult<Self>

Parse from a mutable byte slice reference. The slice is advanced past the consumed bytes.

fn from_bytes(data: &[u8]) -> Result<Self>

Parse from a complete byte slice.

fn set_msg_type(&mut self, _msg_type: u16)

Record the nlmsg_type this message arrived with.