|
1 | 1 | // SPDX-License-Identifier: MIT
|
2 | 2 |
|
| 3 | +//! The `netlink-packet-route` crate is designed to abstract Netlink route |
| 4 | +//! protocol(`rtnetlink`) packet into Rust data types. The goal of this crate is |
| 5 | +//! saving netlink user from reading Kernel Netlink codes. |
| 6 | +//! |
| 7 | +//! This crate grouped Netlink route protocol into these modules: |
| 8 | +//! * `link`: NIC interface, similar to to `ip link` command. |
| 9 | +//! * `address`: IP address, similar to `ip address` command. |
| 10 | +//! * `route`: Route, similar to `ip route` command. |
| 11 | +//! * `rule`: Route rule, similar to `ip rule` command. |
| 12 | +//! * `tc`: Traffic control, similar to `tc` command. |
| 13 | +//! * `neighbour`: Neighbour, similar to `ip neighbour` command. |
| 14 | +//! * `neighbour_table`: Neighbour table, similar to `ip ntable` command. |
| 15 | +//! * `nsid`: Namespace, similar to `ip netns` command. |
| 16 | +//! |
| 17 | +//! At the top level of this crate, we also provide: |
| 18 | +//! * [AddressFamily] |
| 19 | +//! |
| 20 | +//! Normally, you should use [`rtnetlink`][rtnetlink_url] instead of using this |
| 21 | +//! crate directly. |
| 22 | +//! |
| 23 | +//! [rtnetlink_url]: https://docs.rs/rtnetlink |
| 24 | +
|
3 | 25 | pub mod address;
|
4 | 26 | pub mod link;
|
5 | 27 | pub mod neighbour;
|
@@ -42,28 +64,6 @@ pub use self::address_family_fallback::AddressFamily;
|
42 | 64 | pub use self::ip::IpProtocol;
|
43 | 65 | pub use self::message::{RouteNetlinkMessage, RouteNetlinkMessageBuffer};
|
44 | 66 |
|
45 |
| -/// The `netlink-packet-route` crate is designed to abstract Netlink route |
46 |
| -/// protocol(`rtnetlink`) packet into Rust data types. The goal of this crate is |
47 |
| -/// saving netlink user from reading Kernel Netlink codes. |
48 |
| -/// |
49 |
| -/// This crate grouped Netlink route protocol into these modules: |
50 |
| -/// * `link`: NIC interface, similar to to `ip link` command. |
51 |
| -/// * `address`: IP address, similar to `ip address` command. |
52 |
| -/// * `route`: Route, similar to `ip route` command. |
53 |
| -/// * `rule`: Route rule, similar to `ip rule` command. |
54 |
| -/// * `tc`: Traffic control, similar to `tc` command. |
55 |
| -/// * `neighbour`: Neighbour, similar to `ip neighbour` command. |
56 |
| -/// * `neighbour_table`: Neighbour table, similar to `ip ntable` command. |
57 |
| -/// * `nsid`: Namespace, similar to `ip netns` command. |
58 |
| -/// |
59 |
| -/// At the top level of this crate, we also provide: |
60 |
| -/// * [AddressFamily] |
61 |
| -/// |
62 |
| -/// Normally, you should use [`rtnetlink`][rtnetlink_url] instead of using this |
63 |
| -/// crate directly. |
64 |
| -/// |
65 |
| -/// [rtnetlink_url]: https://docs.rs/rtnetlink |
66 |
| -
|
67 | 67 | #[macro_use]
|
68 | 68 | extern crate netlink_packet_utils;
|
69 | 69 |
|
|
0 commit comments