maliput 0.26.0

Rust API for maliput
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
175
176
177
178
179
180

// BSD 3-Clause License
//
// Copyright (c) 2025, Woven by Toyota.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
//   list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// * Neither the name of the copyright holder nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

/// Error types for maliput lib.
#[derive(Debug, PartialEq, Eq, thiserror::Error)]
pub enum MaliputError {
    #[error("Maliput Road Network description parser error: {0}")]
    RoadNetworkDescriptionParserError(String),
    #[error("Maliput Road Geometry construction error: {0}")]
    RoadGeometryConstructionError(String),
    #[error("Maliput Rulebook error: {0}")]
    RulebookError(String),
    #[error("Maliput Rule Registry error: {0}")]
    RuleRegistryError(String),
    #[error("Maliput Traffic Light book error: {0}")]
    TrafficLightBookError(String),
    #[error("Maliput Phase book error: {0}")]
    PhaseBookError(String),
    #[error("Maliput State Provider error: {0}")]
    StateProviderError(String),
    #[error("Maliput assertion error: {0}")]
    AssertionError(String),
    #[error("Maliput OBJ creation error: {0}")]
    ObjCreationError(String),
    #[error("Other: {0}")]
    Other(String),
}

impl From<cxx::Exception> for MaliputError {
    fn from(e: cxx::Exception) -> Self {
        let msg = e.to_string();
        if msg.contains("maliput::common::road_network_description_parser_error") {
            MaliputError::RoadNetworkDescriptionParserError(msg)
        } else if msg.contains("maliput::common::road_geometry_construction_error") {
            MaliputError::RoadGeometryConstructionError(msg)
        } else if msg.contains("maliput::common::rulebook_error") {
            MaliputError::RulebookError(msg)
        } else if msg.contains("maliput::common::rule_registry_error") {
            MaliputError::RuleRegistryError(msg)
        } else if msg.contains("maliput::common::traffic_light_book_error") {
            MaliputError::TrafficLightBookError(msg)
        } else if msg.contains("maliput::common::phase_book_error") {
            MaliputError::PhaseBookError(msg)
        } else if msg.contains("maliput::common::state_provider_error") {
            MaliputError::StateProviderError(msg)
        } else if msg.contains("maliput::common::assertion_error") {
            MaliputError::AssertionError(msg)
        } else {
            MaliputError::Other(msg)
        }
    }
}

/// Log levels for the under the hood maliput library's logging system.
///
/// See https://github.com/maliput/maliput/blob/main/include/maliput/common/logger.h
/// for more details on the logging system and available log levels.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LogLevel {
    Off,
    Trace,
    Debug,
    Info,
    Warn,
    Error,
    Critical,
    Unchanged,
}

impl From<LogLevel> for &'static str {
    fn from(level: LogLevel) -> Self {
        match level {
            LogLevel::Off => "off",
            LogLevel::Trace => "trace",
            LogLevel::Debug => "debug",
            LogLevel::Info => "info",
            LogLevel::Warn => "warn",
            LogLevel::Error => "error",
            LogLevel::Critical => "critical",
            LogLevel::Unchanged => "unchanged",
        }
    }
}
impl From<String> for LogLevel {
    fn from(level: String) -> Self {
        match level.as_str() {
            "off" => LogLevel::Off,
            "trace" => LogLevel::Trace,
            "debug" => LogLevel::Debug,
            "info" => LogLevel::Info,
            "warn" => LogLevel::Warn,
            "error" => LogLevel::Error,
            "critical" => LogLevel::Critical,
            "unchanged" => LogLevel::Unchanged,
            _ => panic!("Invalid log level: {}", level),
        }
    }
}
impl std::fmt::Display for LogLevel {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            LogLevel::Off => write!(f, "off"),
            LogLevel::Trace => write!(f, "trace"),
            LogLevel::Debug => write!(f, "debug"),
            LogLevel::Info => write!(f, "info"),
            LogLevel::Warn => write!(f, "warn"),
            LogLevel::Error => write!(f, "error"),
            LogLevel::Critical => write!(f, "critical"),
            LogLevel::Unchanged => write!(f, "unchanged"),
        }
    }
}

/// Set the log level for the maliput library's logging system.
///
/// # Arguments
///
/// * `level` - The desired log level to set. This should be one of the variants of `LogLevel`.
///
/// # Returns
///
/// A string indicating the previous log level before the change.
///
pub fn set_log_level(level: LogLevel) -> LogLevel {
    maliput_sys::common::ffi::LOG_set_log_level(level.into()).into()
}

#[cfg(test)]
mod tests {
    use super::set_log_level;
    use super::LogLevel;
    #[test]
    fn test_log_level() {
        set_log_level(LogLevel::Off);
        let last_level = set_log_level(LogLevel::Trace);
        assert_eq!(last_level, LogLevel::Off);
        let last_level = set_log_level(LogLevel::Debug);
        assert_eq!(last_level, LogLevel::Trace);
        let last_level = set_log_level(LogLevel::Info);
        assert_eq!(last_level, LogLevel::Debug);
        let last_level = set_log_level(LogLevel::Warn);
        assert_eq!(last_level, LogLevel::Info);
        let last_level = set_log_level(LogLevel::Error);
        assert_eq!(last_level, LogLevel::Warn);
        let last_level = set_log_level(LogLevel::Critical);
        assert_eq!(last_level, LogLevel::Error);
        let last_level = set_log_level(LogLevel::Unchanged);
        assert_eq!(last_level, LogLevel::Critical);
        let last_level = set_log_level(LogLevel::Off);
        assert_eq!(last_level, LogLevel::Critical);
        // TODO(francocipollone): Test an invalid log level. It throws under the hood in c++.
    }
}