Struct netlink_packet_route::rtnl::route::RouteHeader [−][src]
pub struct RouteHeader {
pub address_family: u8,
pub destination_prefix_length: u8,
pub source_prefix_length: u8,
pub tos: u8,
pub table: u8,
pub protocol: u8,
pub scope: u8,
pub kind: u8,
pub flags: RouteFlags,
}
Expand description
High level representation of RTM_GETROUTE
, RTM_ADDROUTE
, RTM_DELROUTE
messages headers.
These headers have the following structure:
0 8 16 24 32
+----------------+----------------+----------------+----------------+
| address family | dest. length | source length | tos |
+----------------+----------------+----------------+----------------+
| table | protocol | scope | type (kind) |
+----------------+----------------+----------------+----------------+
| flags |
+----------------+----------------+----------------+----------------+
Example
extern crate netlink_packet_route;
use netlink_packet_route::{constants::*, RouteFlags, RouteHeader};
fn main() {
let mut hdr = RouteHeader::default();
assert_eq!(hdr.address_family, 0u8);
assert_eq!(hdr.destination_prefix_length, 0u8);
assert_eq!(hdr.source_prefix_length, 0u8);
assert_eq!(hdr.tos, 0u8);
assert_eq!(hdr.table, RT_TABLE_UNSPEC);
assert_eq!(hdr.protocol, RTPROT_UNSPEC);
assert_eq!(hdr.scope, RT_SCOPE_UNIVERSE);
assert_eq!(hdr.kind, RTN_UNSPEC);
assert_eq!(hdr.flags.bits(), 0u32);
// set some values
hdr.destination_prefix_length = 8;
hdr.table = RT_TABLE_MAIN;
hdr.protocol = RTPROT_KERNEL;
hdr.scope = RT_SCOPE_NOWHERE;
// ...
}
Fields
address_family: u8
destination_prefix_length: u8
Prefix length of the destination subnet.
Note that setting
source_prefix_length: u8
Prefix length of the source address.
There could be multiple addresses from which a certain network is reachable. To decide which source address to use to reach and address in that network, the kernel rely on the route’s source address for this destination.
For instance, interface if1
could have two addresses 10.0.0.1/24
and 10.0.0.128/24
,
and we could have the following routes:
10.0.0.10/32 dev if1 scope link src 10.0.0.1
10.0.0.11/32 dev if1 scope link src 10.0.0.1
10.0.0.12/32 dev if1 scope link src 10.0.0.1
10.0.0.0/24 dev if1 scope link src 10.0.0.128
It means that for 10.0.0.10
, 10.0.0.11
and 10.0.0.12
the packets will be sent with
10.0.0.1
as source address, while for the rest of the 10.0.0.0/24
subnet, the source
address will be 10.0.0.128
tos: u8
TOS filter
table: u8
Routing table ID. It can be one of the RT_TABLE_*
constants or a custom table number
between 1 and 251 (included). Note that Linux supports routing table with an ID greater than
255, in which case this attribute will be set to RT_TABLE_COMPAT
and an [Nla::Table
]
netlink attribute will be present in the message.
protocol: u8
Protocol from which the route was learnt. It should be set to one of the RTPROT_*
constants.
scope: u8
The scope of the area where the addresses in the destination subnet are valid. Predefined
scope values are the RT_SCOPE_*
constants.
kind: u8
Route type. It should be set to one of the RTN_*
constants.
flags: RouteFlags
Flags when querying the kernel with a RTM_GETROUTE
message. See RouteFlags
.
Trait Implementations
Returns the “default value” for a type. Read more
Deserialize the current type.
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for RouteHeader
impl Send for RouteHeader
impl Sync for RouteHeader
impl Unpin for RouteHeader
impl UnwindSafe for RouteHeader
Blanket Implementations
Mutably borrows from an owned value. Read more