phoxal 0.29.0

Phoxal - production-oriented autonomous robot framework: the runtime engine and model (the api contract tree lives in phoxal-api, the typed bus in phoxal-bus).
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Role {
    Localization,
    Mapping,
    Traversability,
    Safety,
    Odometry,
    Perception,
}

impl Role {
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Localization => "localization",
            Self::Mapping => "mapping",
            Self::Traversability => "traversability",
            Self::Safety => "safety",
            Self::Odometry => "odometry",
            Self::Perception => "perception",
        }
    }

    #[must_use]
    pub const fn allows_multiple_capabilities(self) -> bool {
        matches!(
            self,
            Self::Localization
                | Self::Mapping
                | Self::Traversability
                | Self::Safety
                | Self::Perception
        )
    }
}

impl std::fmt::Display for Role {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.write_str(self.as_str())
    }
}

#[cfg(test)]
mod tests {
    use super::Role;

    #[test]
    fn allows_multiple_capabilities_matches_blueprint_intent() {
        // Multi-input roles: aggregating contracts that fuse evidence.
        assert!(Role::Localization.allows_multiple_capabilities());
        assert!(Role::Mapping.allows_multiple_capabilities());
        assert!(Role::Traversability.allows_multiple_capabilities());
        assert!(Role::Safety.allows_multiple_capabilities());
        assert!(Role::Perception.allows_multiple_capabilities());

        // Single-input roles: one canonical capability per robot.
        assert!(!Role::Odometry.allows_multiple_capabilities());
    }
}