rscamper 0.2.2

Rust interface to scamper network measurement tool
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

// rscamper - Rust wrapper for ICMP extensions
//
// Copyright (C) 2026 Dimitrios Giakatos
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 3.

use crate::ffi::scamper_icmpext::{self, ScamperIcmpextT, ScamperIcmpextsT};

/// A single ICMP extension entry (e.g. an MPLS label stack).
pub struct ScamperIcmpExt {
    inner: *mut ScamperIcmpextT,
}

impl ScamperIcmpExt {
    pub(crate) unsafe fn from_ptr(ptr: *mut ScamperIcmpextT) -> Option<Self> {
        if ptr.is_null() {
            return None;
        }
        let ptr = unsafe { scamper_icmpext::scamper_icmpext_use(ptr) };
        Some(ScamperIcmpExt { inner: ptr })
    }

    /// Return true if this extension is an MPLS label stack.
    pub fn is_mpls(&self) -> bool {
        unsafe { scamper_icmpext::scamper_icmpext_is_mpls(self.inner) != 0 }
    }

    /// Return the number of MPLS labels.
    pub fn mpls_count(&self) -> u16 {
        unsafe { scamper_icmpext::scamper_icmpext_mpls_count_get(self.inner) }
    }

    /// Return the MPLS label at index `i`.
    pub fn mpls_label(&self, i: u16) -> u32 {
        unsafe { scamper_icmpext::scamper_icmpext_mpls_label_get(self.inner, i) }
    }

    /// Return the MPLS TTL at index `i`.
    pub fn mpls_ttl(&self, i: u16) -> u8 {
        unsafe { scamper_icmpext::scamper_icmpext_mpls_ttl_get(self.inner, i) }
    }

    /// Return the MPLS experimental bits at index `i`.
    pub fn mpls_exp(&self, i: u16) -> u8 {
        unsafe { scamper_icmpext::scamper_icmpext_mpls_exp_get(self.inner, i) }
    }

    /// Return the MPLS bottom-of-stack bit at index `i`.
    pub fn mpls_s(&self, i: u16) -> u8 {
        unsafe { scamper_icmpext::scamper_icmpext_mpls_s_get(self.inner, i) }
    }

    /// Return an iterator over MPLS label stack entries.
    pub fn mpls_labels(&self) -> MplsIter<'_> {
        MplsIter { ext: self, index: 0, count: self.mpls_count() }
    }
}

impl Drop for ScamperIcmpExt {
    fn drop(&mut self) {
        unsafe { scamper_icmpext::scamper_icmpext_free(self.inner) };
    }
}

impl Clone for ScamperIcmpExt {
    fn clone(&self) -> Self {
        let ptr = unsafe { scamper_icmpext::scamper_icmpext_use(self.inner) };
        ScamperIcmpExt { inner: ptr }
    }
}

unsafe impl Send for ScamperIcmpExt {}
unsafe impl Sync for ScamperIcmpExt {}

/// An MPLS label stack entry.
#[derive(Debug, Clone, Copy)]
pub struct MplsLabel {
    pub label: u32,
    pub ttl: u8,
    pub exp: u8,
    pub s: u8,
}

/// Iterator over MPLS labels in a ScamperIcmpExt.
pub struct MplsIter<'a> {
    ext: &'a ScamperIcmpExt,
    index: u16,
    count: u16,
}

impl<'a> Iterator for MplsIter<'a> {
    type Item = MplsLabel;
    fn next(&mut self) -> Option<Self::Item> {
        if self.index >= self.count {
            return None;
        }
        let i = self.index;
        self.index += 1;
        Some(MplsLabel {
            label: self.ext.mpls_label(i),
            ttl:   self.ext.mpls_ttl(i),
            exp:   self.ext.mpls_exp(i),
            s:     self.ext.mpls_s(i),
        })
    }
}

/// A container of ICMP extensions.
pub struct ScamperIcmpExts {
    inner: *mut ScamperIcmpextsT,
}

impl ScamperIcmpExts {
    pub(crate) unsafe fn from_ptr(ptr: *mut ScamperIcmpextsT) -> Option<Self> {
        if ptr.is_null() {
            return None;
        }
        let ptr = unsafe { scamper_icmpext::scamper_icmpexts_use(ptr) };
        Some(ScamperIcmpExts { inner: ptr })
    }

    /// Return the number of extensions.
    pub fn count(&self) -> u16 {
        unsafe { scamper_icmpext::scamper_icmpexts_count_get(self.inner) }
    }

    /// Return extension at index `i`.
    pub fn get(&self, i: u16) -> Option<ScamperIcmpExt> {
        let ptr = unsafe { scamper_icmpext::scamper_icmpexts_ext_get(self.inner, i) };
        unsafe { ScamperIcmpExt::from_ptr(ptr) }
    }

    /// Iterate over all extensions.
    pub fn iter(&self) -> IcmpExtsIter<'_> {
        IcmpExtsIter { exts: self, index: 0, count: self.count() }
    }
}

impl Drop for ScamperIcmpExts {
    fn drop(&mut self) {
        unsafe { scamper_icmpext::scamper_icmpexts_free(self.inner) };
    }
}

impl Clone for ScamperIcmpExts {
    fn clone(&self) -> Self {
        let ptr = unsafe { scamper_icmpext::scamper_icmpexts_use(self.inner) };
        ScamperIcmpExts { inner: ptr }
    }
}

unsafe impl Send for ScamperIcmpExts {}
unsafe impl Sync for ScamperIcmpExts {}

/// Iterator over ScamperIcmpExts.
pub struct IcmpExtsIter<'a> {
    exts: &'a ScamperIcmpExts,
    index: u16,
    count: u16,
}

impl<'a> Iterator for IcmpExtsIter<'a> {
    type Item = ScamperIcmpExt;
    fn next(&mut self) -> Option<Self::Item> {
        if self.index >= self.count {
            return None;
        }
        let i = self.index;
        self.index += 1;
        self.exts.get(i)
    }
}