aboutsummaryrefslogtreecommitdiff
path: root/nftnl/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'nftnl/src/lib.rs')
-rw-r--r--nftnl/src/lib.rs14
1 files changed, 14 insertions, 0 deletions
diff --git a/nftnl/src/lib.rs b/nftnl/src/lib.rs
index 5bfb967..69cb1c8 100644
--- a/nftnl/src/lib.rs
+++ b/nftnl/src/lib.rs
@@ -6,6 +6,20 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.
+//! Safe abstraction for [`libnftnl`]. Provides low-level userspace access to the in-kernel
+//! nf_tables subsystem. See [`nftnl-sys`] for the low level FFI bindings to the C library.
+//!
+//! Can be used to create and remove tables, chains, sets and rules from the nftables firewall,
+//! the successor to iptables.
+//!
+//! # Selecting version of `libnftnl`
+//!
+//! See the documentation for the corresponding sys crate for details: [`nftnl-sys`]
+//! This crate has the same features as the sys crate, and selecting version works the same.
+//!
+//! [`libnftnl`]: https://netfilter.org/projects/libnftnl/
+//! [`nftnl-sys`]: https://crates.io/crates/nftnl-sys
+
pub extern crate nftnl_sys;
#[macro_use]