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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
use super::ValueDescriptions;
use crate::compat::ValueDescEntries;
impl ValueDescriptions {
/// Create ValueDescriptions from a Vec of (value, description) pairs
pub(crate) fn new(entries: ValueDescEntries) -> Self {
// Validation should have been done prior (by builder or parse)
Self { entries }
}
/// Get the description for a numeric value
///
/// # Examples
///
/// ```rust,no_run
/// # use dbc_rs::Dbc;
/// # let dbc = Dbc::parse(r#"VERSION "1.0"\n\nBU_: ECM\n\nBO_ 100 Engine : 8 ECM\n SG_ Gear : 0|8@1+ (1,0) [0|5] "" *\n\nVAL_ 100 Gear 0 "Park" 1 "Reverse" ;"#)?;
/// # let message = dbc.messages().iter().next().unwrap();
/// # let signal = message.signals().iter().next().unwrap();
/// if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
/// if let Some(desc) = value_descriptions.get(0) {
/// println!("Value 0: {}", desc);
/// }
/// }
/// # Ok::<(), dbc_rs::Error>(())
/// ```
#[must_use = "return value should be used"]
pub fn get(&self, value: u64) -> Option<&str> {
for (v, desc) in &self.entries {
if *v == value {
return Some(desc.as_ref());
}
}
None
}
/// Returns the number of value descriptions.
///
/// # Examples
///
/// ```rust,no_run
/// # use dbc_rs::Dbc;
/// # let dbc = Dbc::parse(r#"VERSION "1.0"\n\nBU_: ECM\n\nBO_ 100 Engine : 8 ECM\n SG_ Gear : 0|8@1+ (1,0) [0|5] "" *\n\nVAL_ 100 Gear 0 "Park" 1 "Reverse" 2 "Neutral" ;"#)?;
/// # let message = dbc.messages().iter().next().unwrap();
/// # let signal = message.signals().iter().next().unwrap();
/// if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
/// assert_eq!(value_descriptions.len(), 3);
/// }
/// # Ok::<(), dbc_rs::Error>(())
/// ```
#[must_use = "return value should be used"]
pub fn len(&self) -> usize {
self.entries.len()
}
/// Returns `true` if there are no value descriptions.
///
/// # Examples
///
/// ```rust,no_run
/// # use dbc_rs::Dbc;
/// # let dbc = Dbc::parse(r#"VERSION "1.0"\n\nBU_: ECM\n\nBO_ 100 Engine : 8 ECM\n SG_ Gear : 0|8@1+ (1,0) [0|5] "" *\n\nVAL_ 100 Gear 0 "Park" ;"#)?;
/// # let message = dbc.messages().iter().next().unwrap();
/// # let signal = message.signals().iter().next().unwrap();
/// if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
/// assert!(!value_descriptions.is_empty());
/// }
/// # Ok::<(), dbc_rs::Error>(())
/// ```
#[must_use = "return value should be used"]
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
/// Get a value description by index.
///
/// Returns `None` if the index is out of bounds.
///
/// # Arguments
///
/// * `index` - The zero-based index of the value description
///
/// # Examples
///
/// ```rust,no_run
/// # use dbc_rs::Dbc;
/// # let dbc = Dbc::parse(r#"VERSION "1.0"\n\nBU_: ECM\n\nBO_ 100 Engine : 8 ECM\n SG_ Gear : 0|8@1+ (1,0) [0|5] "" *\n\nVAL_ 100 Gear 0 "Park" 1 "Reverse" ;"#)?;
/// # let message = dbc.messages().iter().next().unwrap();
/// # let signal = message.signals().iter().next().unwrap();
/// if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
/// if let Some((value, description)) = value_descriptions.at(0) {
/// println!("Value {}: {}", value, description);
/// }
/// }
/// # Ok::<(), dbc_rs::Error>(())
/// ```
#[must_use = "return value should be used"]
pub fn at(&self, index: usize) -> Option<(u64, &str)> {
self.entries.get(index).map(|(value, desc)| (*value, desc.as_str()))
}
/// Iterate over all value descriptions
///
/// # Examples
///
/// ```rust,no_run
/// # use dbc_rs::Dbc;
/// # let dbc = Dbc::parse(r#"VERSION "1.0"\n\nBU_: ECM\n\nBO_ 100 Engine : 8 ECM\n SG_ Gear : 0|8@1+ (1,0) [0|5] "" *\n\nVAL_ 100 Gear 0 "Park" 1 "Reverse" ;"#)?;
/// # let message = dbc.messages().iter().next().unwrap();
/// # let signal = message.signals().iter().next().unwrap();
/// if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
/// for (value, description) in value_descriptions.iter() {
/// println!("{} -> {}", value, description);
/// }
/// }
/// # Ok::<(), dbc_rs::Error>(())
/// ```
#[inline]
#[must_use = "iterator is lazy and does nothing unless consumed"]
pub fn iter(&self) -> impl Iterator<Item = (u64, &str)> + '_ {
self.entries.iter().map(|(value, desc)| (*value, desc.as_str()))
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::MAX_NAME_SIZE;
use crate::compat::{String, Vec};
fn create_test_entries() -> ValueDescEntries {
let mut entries: Vec<(u64, String<{ MAX_NAME_SIZE }>), 64> = Vec::new();
let _ = entries.push((0, String::try_from("Park").unwrap()));
let _ = entries.push((1, String::try_from("Reverse").unwrap()));
let _ = entries.push((2, String::try_from("Neutral").unwrap()));
let _ = entries.push((3, String::try_from("Drive").unwrap()));
entries
}
#[test]
fn test_value_descriptions_get() {
let vd = ValueDescriptions::new(create_test_entries());
assert_eq!(vd.get(0), Some("Park"));
assert_eq!(vd.get(1), Some("Reverse"));
assert_eq!(vd.get(2), Some("Neutral"));
assert_eq!(vd.get(3), Some("Drive"));
assert_eq!(vd.get(4), None);
assert_eq!(vd.get(100), None);
}
#[test]
fn test_value_descriptions_len() {
let vd = ValueDescriptions::new(create_test_entries());
assert_eq!(vd.len(), 4);
}
#[test]
fn test_value_descriptions_is_empty() {
let vd = ValueDescriptions::new(create_test_entries());
assert!(!vd.is_empty());
let empty_entries: ValueDescEntries = Vec::new();
let empty_vd = ValueDescriptions::new(empty_entries);
assert!(empty_vd.is_empty());
}
#[test]
fn test_value_descriptions_at() {
let vd = ValueDescriptions::new(create_test_entries());
assert_eq!(vd.at(0), Some((0, "Park")));
assert_eq!(vd.at(1), Some((1, "Reverse")));
assert_eq!(vd.at(2), Some((2, "Neutral")));
assert_eq!(vd.at(3), Some((3, "Drive")));
assert_eq!(vd.at(4), None);
assert_eq!(vd.at(100), None);
}
#[test]
fn test_value_descriptions_iter() {
let vd = ValueDescriptions::new(create_test_entries());
let mut collected: Vec<(u64, &str), 64> = Vec::new();
for item in vd.iter() {
let _ = collected.push(item);
}
assert_eq!(collected.len(), 4);
assert_eq!(collected[0], (0, "Park"));
assert_eq!(collected[1], (1, "Reverse"));
assert_eq!(collected[2], (2, "Neutral"));
assert_eq!(collected[3], (3, "Drive"));
}
#[test]
fn test_value_descriptions_empty_iter() {
let empty_entries: ValueDescEntries = Vec::new();
let vd = ValueDescriptions::new(empty_entries);
let mut collected: Vec<(u64, &str), 64> = Vec::new();
for item in vd.iter() {
let _ = collected.push(item);
}
assert!(collected.is_empty());
}
}