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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

// SPDX-License-Identifier: MIT

use super::{
    LinkAddRequest, LinkDelPropRequest, LinkDelRequest, LinkGetRequest,
    LinkNewPropRequest, LinkSetRequest,
};
use crate::{
    packet_core::{NLM_F_ACK, NLM_F_REQUEST},
    packet_route::link::LinkMessage,
    Handle,
};

pub struct LinkHandle(Handle);

impl LinkHandle {
    pub fn new(handle: Handle) -> Self {
        LinkHandle(handle)
    }

    /// Using `RTM_SETLINK`. Currently this is only used for bridge commands
    /// like `bridge vlan` and `bridge vlan`.
    /// For changing existing network interface, please use
    /// [LinkHandle::add()]
    pub fn set(&self, message: LinkMessage) -> LinkSetRequest {
        LinkSetRequest::new(self.0.clone(), message)
    }

    pub fn add(&self, message: LinkMessage) -> LinkAddRequest {
        LinkAddRequest::new(self.0.clone(), message)
    }

    /// Equal to `ip link set` command.
    pub fn change(&self, message: LinkMessage) -> LinkAddRequest {
        LinkAddRequest::new(self.0.clone(), message)
            .set_flags(NLM_F_REQUEST | NLM_F_ACK)
    }

    pub fn property_add(&self, index: u32) -> LinkNewPropRequest {
        LinkNewPropRequest::new(self.0.clone(), index)
    }

    pub fn property_del(&self, index: u32) -> LinkDelPropRequest {
        LinkDelPropRequest::new(self.0.clone(), index)
    }

    pub fn del(&self, index: u32) -> LinkDelRequest {
        LinkDelRequest::new(self.0.clone(), index)
    }

    /// Delete specified information from interface.
    /// For example: To delete bridge VLANs, it is required to include
    /// LinkMessage of VLAN information to delete.
    pub fn del_with_message(&self, message: LinkMessage) -> LinkDelRequest {
        LinkDelRequest::new_with_message(self.0.clone(), message)
    }

    /// Retrieve the list of links (equivalent to `ip link show`)
    pub fn get(&self) -> LinkGetRequest {
        LinkGetRequest::new(self.0.clone())
    }

    /// The `LinkHandle::set()` cannot be used for setting bond or bridge port
    /// configuration, `RTM_NEWLINK` and `NLM_F_REQUEST|NLM_F_ACK` are required,
    /// Equal to `LinkAddRequest::new().set_flags(NLM_F_REQUEST | NLM_F_ACK)`
    pub fn set_port(&self, message: LinkMessage) -> LinkAddRequest {
        LinkAddRequest::new(self.0.clone(), message)
            .set_flags(NLM_F_REQUEST | NLM_F_ACK)
    }
}