rrplug 4.2.1

framework for R2Northstar plugins
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

//! wrappers for structs that are passed to the plugin

use std::ffi::CStr;

use crate::bindings::plugin_abi::{PluginColor, PluginContext};

/// information about the plugin that the plugins system requests
#[derive(Debug)]
pub struct PluginInfo {
    name: &'static CStr,
    log_name: &'static CStr,
    dependency_name: &'static CStr,
    context: PluginContext,
    color: PluginColor,
}

impl PluginInfo {
    /// Creates a new [`PluginInfo`].
    ///
    /// # Panics
    ///
    /// Panics if the following conditions are not met
    /// - the strings have to be null terminated
    /// - strings cannot be empty
    /// - log name has to be 9 chars in lenght (not counting the null terminator)
    pub const fn new(
        name: &'static CStr,
        log_name: &'static CStr,
        dependency_name: &'static CStr,
        context: PluginContext,
    ) -> Self {
        assert!(name.to_bytes().len() > 1, "consider actually having a name");
        assert!(
            log_name.to_bytes().len() > 1,
            "consider actually having a log_name"
        );
        assert!(
            dependency_name.to_bytes().len() > 1,
            "consider actually having a dependency_name"
        );
        assert!(log_name.to_bytes().len() == 9, "log name is used for logging and ideally should be 9 chars long and all upercase to look like every other log str");
        // assert!(dependency_name.to_bytes() ); // TODO a check valid constants
        Self {
            name,
            log_name,
            dependency_name,
            context,
            color: PluginColor {
                red: 244,
                green: 106,
                blue: 14,
            },
        }
    }

    /// Creates a new [`PluginInfo`] but with a color for logs.
    ///
    /// # Panics
    /// refer to `new`
    pub const fn new_with_color(
        name: &'static CStr,
        log_name: &'static CStr,
        dependency_name: &'static CStr,
        context: PluginContext,
        color: PluginColor,
    ) -> Self {
        Self {
            color,
            ..Self::new(name, log_name, dependency_name, context)
        }
    }

    /// Returns a reference to the name of the plugin.
    pub const fn get_name(&self) -> &'static CStr {
        self.name
    }
    /// Returns a reference to the log name of the plugin.
    pub const fn get_log_name(&self) -> &'static CStr {
        self.log_name
    }
    /// Returns a reference to the dependency name of the plugin.
    pub const fn get_dependency_name(&self) -> &'static CStr {
        self.dependency_name
    }
    /// Returns the context of the plugin.
    pub const fn get_context(&self) -> PluginContext {
        self.context
    }
    /// Returns the color of the plugin.
    pub const fn get_color(&self) -> PluginColor {
        self.color
    }
}