rtnetlink 0.21.0

manipulate linux networking resources via netlink
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

// SPDX-License-Identifier: MIT

use crate::{
    packet_route::link::{InfoData, InfoKind, InfoVeth},
    LinkMessageBuilder, LinkUnspec,
};

#[derive(Debug)]
/// Represent virtual ethernet interface.
/// Example code on creating a veth pair
/// ```no_run
/// use rtnetlink::{new_connection, LinkVeth};
/// #[tokio::main]
/// async fn main() -> Result<(), String> {
///     let (connection, handle, _) = new_connection().unwrap();
///     tokio::spawn(connection);
///
///     handle
///         .link()
///         .add(LinkVeth::new("veth1", "veth1-peer").build())
///         .execute()
///         .await
///         .map_err(|e| format!("{e}"))
/// }
/// ```
///
/// Please check LinkMessageBuilder::<LinkVeth> for more detail.
pub struct LinkVeth;

impl LinkVeth {
    /// Equal to `LinkMessageBuilder::<LinkVeth>::new(name, peer)`
    pub fn new(name: &str, peer: &str) -> LinkMessageBuilder<Self> {
        LinkMessageBuilder::<LinkVeth>::new(name, peer)
    }
}

impl LinkMessageBuilder<LinkVeth> {
    /// Create [LinkMessageBuilder] for VETH
    pub fn new(name: &str, peer: &str) -> Self {
        LinkMessageBuilder::<LinkVeth>::new_with_info_kind(InfoKind::Veth)
            .name(name.to_string())
            .peer(peer)
    }

    pub fn peer(mut self, peer: &str) -> Self {
        let peer_msg = LinkMessageBuilder::<LinkUnspec>::new()
            .name(peer.to_string())
            .build();

        self.info_data = Some(InfoData::Veth(InfoVeth::Peer(peer_msg)));
        self
    }
}