nlink 0.28.1

Async netlink library for Linux network configuration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! Compile the recipe markdown as doctests — #319.
//!
//! Nothing compiled `docs/recipes/`. 91 Rust blocks across 21 files, checked
//! only by `scripts/audit-recipe-drift.sh`, a grep gate whose own header
//! calls itself a stop-gap for "a synthetic compile-fixture per recipe
//! block". This is that fixture, and it needs no generator: rustdoc compiles
//! every fenced Rust block in a markdown file pulled in with `include_str!`,
//! so an empty module per recipe is the whole harness.
//!
//! `#[cfg(doctest)]` on the parent means these modules exist only when
//! rustdoc is collecting doctests — they cost nothing in a normal build.
//!
//! The `include_str!` paths reach above the package root, so the recipes are
//! not in the published tarball and this module only resolves in-tree. That
//! is fine for what it is: `#[cfg(doctest)]` means a normal build and
//! `cargo doc` (docs.rs included) never compile it, and the consumer of the
//! check is this repository's CI.
//!
//! A recipe whose code needs a feature is gated on it here, the same way
//! the crate's own doc examples are: rustdoc skips a `#[cfg]`-ed-out item's
//! documentation, and an ungated recipe would fail the default-feature
//! `cargo test --doc` for want of `nlink::lab`.
//!
//! A new recipe belongs here the day it is written. `cargo test --doc` is
//! then the only thing that has to agree the recipe is real.

#[doc = include_str!("../../../docs/recipes/bidirectional-rate-limit.md")]
mod bidirectional_rate_limit {}

#[doc = include_str!("../../../docs/recipes/bridge-vlan.md")]
mod bridge_vlan {}

#[doc = include_str!("../../../docs/recipes/cgroup-classification.md")]
mod cgroup_classification {}

#[doc = include_str!("../../../docs/recipes/connection-pool.md")]
mod connection_pool {}

#[cfg(feature = "lab")]
#[doc = include_str!("../../../docs/recipes/conntrack-programmatic.md")]
mod conntrack_programmatic {}

#[doc = include_str!("../../../docs/recipes/define-your-own-genl-family.md")]
mod define_your_own_genl_family {}

#[doc = include_str!("../../../docs/recipes/dpll-monitor.md")]
mod dpll_monitor {}

#[doc = include_str!("../../../docs/recipes/error-handling-patterns.md")]
mod error_handling_patterns {}

#[doc = include_str!("../../../docs/recipes/events-with-resync.md")]
mod events_with_resync {}

#[cfg(feature = "namespace_watcher")]
#[doc = include_str!("../../../docs/recipes/multi-namespace-events.md")]
mod multi_namespace_events {}

#[doc = include_str!("../../../docs/recipes/netdev-lifecycle.md")]
mod netdev_lifecycle {}

#[cfg(feature = "serde")]
#[doc = include_str!("../../../docs/recipes/nftables-declarative-config.md")]
mod nftables_declarative_config {}

#[cfg(feature = "lab")]
#[doc = include_str!("../../../docs/recipes/nftables-stateful-fw.md")]
mod nftables_stateful_fw {}

#[doc = include_str!("../../../docs/recipes/nftables-watch-with-resync.md")]
mod nftables_watch_with_resync {}

#[doc = include_str!("../../../docs/recipes/openvpn-dco.md")]
mod openvpn_dco {}

#[doc = include_str!("../../../docs/recipes/per-peer-impairment.md")]
mod per_peer_impairment {}

#[cfg(feature = "sockdiag")]
#[doc = include_str!("../../../docs/recipes/per-process-bandwidth.md")]
mod per_process_bandwidth {}

#[doc = include_str!("../../../docs/recipes/tx-hw-shaping.md")]
mod tx_hw_shaping {}

#[cfg(feature = "lab")]
#[doc = include_str!("../../../docs/recipes/wireguard-mesh.md")]
mod wireguard_mesh {}

#[cfg(feature = "lab")]
#[doc = include_str!("../../../docs/recipes/xfrm-ipsec-tunnel.md")]
mod xfrm_ipsec_tunnel {}