batman-robin 1.0.1

Rust library and CLI tool for interacting with the BATMAN-adv kernel module for mesh networking
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

use crate::Interface;

use clap::{Arg, Command};

/// Creates the CLI command for displaying or modifying batman-adv interfaces.
///
/// # Returns
/// - A `clap::Command` configured with:
///   - Name: `"interface"`
///   - Alias: `"if"`
///   - Short and long description: `"Display or modify the batman-adv interface settings."`
///   - Usage override:
///       ```text
///       robctl [options] interface|if [options] [add|del iface(s)]
///       robctl [options] interface|if [options] create [routing_algo|ra RA_NAME]
///       robctl [options] interface|if [options] destroy
///       ```
///   - Optional flags and arguments:
///       - `-M, --manual`: Disable automatic creation/destruction of batman-adv interface
///       - `action`: Command name, one of `add`, `a`, `del`, `d`, `create`, `c`, `destroy`, `D`
///       - `params`: Additional parameters, either interface names (for add/del) or routing algorithm name (for create)
///   - Version flag disabled
pub fn cmd_interfaces() -> Command {
    Command::new("interface")
        .alias("if")
        .about("Display or modify the batman-adv interface settings.")
        .long_about("Display or modify the batman-adv interface settings.")
        .override_usage(
            "\trobctl [options] interface|if [options] [add|del iface(s)]\n\
                    \trobctl [options] interface|if [options] create [routing_algo|ra RA_NAME]\n\
                    \trobctl [options] interface|if [options] destroy\n",
        )
        .arg(
            Arg::new("manual")
                .short('M')
                .help("Disable automatic creation/destruction of batman-adv interface")
                .action(clap::ArgAction::SetTrue),
        )
        .arg(
            Arg::new("action")
                .index(1)
                .value_name("command")
                .value_parser(["add", "a", "del", "d", "create", "c", "destroy", "D"])
                .help("Command name:"),
        )
        .arg(
            Arg::new("params")
                .index(2)
                .value_name("parameters")
                .num_args(0..)
                .help("Interfaces (add/del) or routing algorithm (create)"),
        )
        .disable_version_flag(true)
}

/// Prints the list of batman-adv interfaces with their current status.
///
/// # Arguments
/// - `interfaces`: Slice of `Interface` structs, each containing:
///     - `ifname`: Name of the interface
///     - `active`: Boolean indicating whether the interface is active
///
/// # Behavior
/// - Prints each interface in the format: `"iface_name: active"` or `"iface_name: inactive"`.
pub fn print_interfaces(interfaces: &[Interface]) {
    for iface in interfaces {
        let status = if iface.active { "active" } else { "inactive" };

        println!("{}: {}", iface.ifname, status);
    }
}