vpp-plugin 0.2.2

A framework for writing high-performance, reliable VPP plugins in Rust.
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

//! VPP networking errors

use std::{
    ffi::{CString, c_int},
    fmt::Display,
};

use crate::bindings::{vnet_error, vnet_error_t};

/// VPP networking error
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct VnetError(vnet_error_t);

impl VnetError {
    /// Creates an error stack from the VPP networking error and adds context
    ///
    /// # Panics
    ///
    /// Panics if the context message contains nul characters.
    pub fn context<M: Display>(self, message: M) -> crate::vppinfra::error::ErrorStack {
        // SAFETY: pointers passed into vnet_error are valid and are valid nul-terminated C
        // strings. vnet_error aborts on memory allocation error so cannot fail and therefore the
        // returned pointer is always valid.
        unsafe {
            let message_c = CString::new(message.to_string())
                .expect("message should not contain nul terminator");
            let ptr = vnet_error(self.0, c"%s".as_ptr().cast_mut().cast(), message_c.as_ptr());
            crate::vppinfra::error::ErrorStack::from_raw(ptr)
        }
    }
}

impl From<c_int> for VnetError {
    fn from(value: c_int) -> Self {
        Self(value)
    }
}

impl From<VnetError> for i32 {
    fn from(value: VnetError) -> Self {
        value.0
    }
}

/// Invalid Argument
pub const VNET_ERR_INVALID_ARGUMENT: VnetError = VnetError(-73);