dbc-rs 0.4.3

Database CAN (DBC) parsing and editing library
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
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use crate::{MAX_SIGNALS_PER_MESSAGE, Signal, compat::Vec};

/// Encapsulates the signals array for a message
///
/// Uses `Vec<Signal>` for dynamic sizing.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Signals {
    signals: Vec<Signal, { MAX_SIGNALS_PER_MESSAGE }>,
}

impl From<&[Signal]> for Signals {
    fn from(signals: &[Signal]) -> Self {
        Self::from_slice(signals)
    }
}

#[cfg(feature = "std")]
impl From<std::vec::Vec<Signal>> for Signals {
    fn from(signals: std::vec::Vec<Signal>) -> Self {
        Self::from_slice(&signals)
    }
}

impl From<Vec<Signal, { MAX_SIGNALS_PER_MESSAGE }>> for Signals {
    fn from(signals: Vec<Signal, { MAX_SIGNALS_PER_MESSAGE }>) -> Self {
        Self::from_slice(signals.as_slice())
    }
}

impl Signals {
    /// Create Signals from a slice of signals by cloning them
    pub(crate) fn from_slice(signals: &[Signal]) -> Self {
        let count = signals.len().min(MAX_SIGNALS_PER_MESSAGE);
        let signals_vec: Vec<Signal, { MAX_SIGNALS_PER_MESSAGE }> =
            signals.iter().take(count).cloned().collect();
        Self {
            signals: signals_vec,
        }
    }

    /// Get an iterator over the signals
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use dbc_rs::Dbc;
    ///
    /// let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM\n SG_ RPM : 0|16@1+ (0.25,0) [0|8000] \"rpm\"")?;
    /// let message = dbc.messages().at(0).unwrap();
    /// for signal in message.signals().iter() {
    ///     println!("Signal: {} (start: {}, length: {})", signal.name(), signal.start_bit(), signal.length());
    /// }
    /// # Ok::<(), dbc_rs::Error>(())
    /// ```
    #[inline]
    #[must_use = "iterator is lazy and does nothing unless consumed"]
    pub fn iter(&self) -> impl Iterator<Item = &Signal> + '_ {
        self.signals.iter()
    }

    /// Get the number of signals
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use dbc_rs::Dbc;
    ///
    /// let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM\n SG_ RPM : 0|16@1+ (0.25,0) [0|8000] \"rpm\"")?;
    /// let message = dbc.messages().at(0).unwrap();
    /// assert_eq!(message.signals().len(), 1);
    /// # Ok::<(), dbc_rs::Error>(())
    /// ```
    #[inline]
    #[must_use = "return value should be used"]
    pub fn len(&self) -> usize {
        self.signals.len()
    }

    /// Returns `true` if there are no signals
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use dbc_rs::Dbc;
    ///
    /// let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM")?;
    /// let message = dbc.messages().at(0).unwrap();
    /// assert!(message.signals().is_empty());
    /// # Ok::<(), dbc_rs::Error>(())
    /// ```
    #[inline]
    #[must_use = "return value should be used"]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Get a signal by index, or None if index is out of bounds
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use dbc_rs::Dbc;
    ///
    /// let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM\n SG_ RPM : 0|16@1+ (0.25,0) [0|8000] \"rpm\"")?;
    /// let message = dbc.messages().at(0).unwrap();
    /// if let Some(signal) = message.signals().at(0) {
    ///     assert_eq!(signal.name(), "RPM");
    /// }
    /// # Ok::<(), dbc_rs::Error>(())
    /// ```
    #[inline]
    #[must_use = "return value should be used"]
    pub fn at(&self, index: usize) -> Option<&Signal> {
        self.signals.get(index)
    }

    /// Find a signal by name, or None if not found
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use dbc_rs::Dbc;
    ///
    /// let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM\n\nBO_ 256 Engine : 8 ECM\n SG_ RPM : 0|16@1+ (0.25,0) [0|8000] \"rpm\"")?;
    /// let message = dbc.messages().at(0).unwrap();
    /// if let Some(signal) = message.signals().find("RPM") {
    ///     assert_eq!(signal.name(), "RPM");
    ///     assert_eq!(signal.factor(), 0.25);
    /// }
    /// # Ok::<(), dbc_rs::Error>(())
    /// ```
    #[must_use = "return value should be used"]
    pub fn find(&self, name: &str) -> Option<&Signal> {
        self.iter().find(|s| s.name() == name)
    }

    /// Find a mutable reference to a signal by name.
    /// Used internally during parsing when CM_ entries are processed after signals.
    #[must_use = "return value should be used"]
    pub(crate) fn find_mut(&mut self, name: &str) -> Option<&mut Signal> {
        self.signals.iter_mut().find(|s| s.name() == name)
    }
}

#[cfg(test)]
mod tests {
    use super::Signals;
    use crate::{Parser, Signal};

    // Tests for from_slice
    #[cfg(feature = "std")]
    mod test_from_slice {
        use super::*;

        #[test]
        fn test_signals_from_slice() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ Signal1 : 0|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Signal2 : 8|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2]);
            assert_eq!(signals.len(), 2);
            assert!(!signals.is_empty());
            assert_eq!(signals.at(0).unwrap().name(), "Signal1");
            assert_eq!(signals.at(1).unwrap().name(), "Signal2");
        }

        #[test]
        fn test_signals_from_signals_slice_empty() {
            let signals = Signals::from_slice(&[]);
            assert_eq!(signals.len(), 0);
            assert!(signals.is_empty());
            assert!(signals.at(0).is_none());
        }

        #[test]
        fn test_signals_from_slice_multiple() {
            // Test with multiple signals to verify capacity handling
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ Signal1 : 0|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Signal2 : 8|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();
            let signal3 = Signal::parse(
                &mut Parser::new(b"SG_ Signal3 : 16|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2, signal3]);
            assert_eq!(signals.len(), 3);
            assert_eq!(signals.at(0).unwrap().name(), "Signal1");
            assert_eq!(signals.at(1).unwrap().name(), "Signal2");
            assert_eq!(signals.at(2).unwrap().name(), "Signal3");
        }
    }

    // Tests for iter()
    mod test_iter {
        use super::*;

        #[test]
        fn test_signals_iter() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Temp : 16|8@0- (1,-40) [-40|215] \"\xC2\xB0C\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2]);
            let mut iter = signals.iter();
            assert_eq!(iter.next().unwrap().name(), "RPM");
            assert_eq!(iter.next().unwrap().name(), "Temp");
            assert!(iter.next().is_none());
        }

        #[test]
        fn test_signals_iter_empty() {
            let signals = Signals::from_slice(&[]);
            let mut iter = signals.iter();
            assert!(iter.next().is_none());
        }

        #[test]
        fn test_signals_iter_multiple() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ Signal1 : 0|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Signal2 : 8|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();
            let signal3 = Signal::parse(
                &mut Parser::new(b"SG_ Signal3 : 16|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2, signal3]);
            let mut iter = signals.iter();
            assert_eq!(iter.next().unwrap().name(), "Signal1");
            assert_eq!(iter.next().unwrap().name(), "Signal2");
            assert_eq!(iter.next().unwrap().name(), "Signal3");
            assert!(iter.next().is_none());
        }
    }

    // Tests for len()
    mod test_len {
        use super::*;

        #[test]
        fn test_signals_len() {
            let signals = Signals::from_slice(&[]);
            assert_eq!(signals.len(), 0);

            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();
            let signals = Signals::from_slice(&[signal1]);
            assert_eq!(signals.len(), 1);
        }
    }

    // Tests for is_empty()
    mod test_is_empty {
        use super::*;

        #[test]
        fn test_signals_is_empty() {
            let signals = Signals::from_slice(&[]);
            assert!(signals.is_empty());
            assert_eq!(signals.len(), 0);

            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();
            let signals = Signals::from_slice(&[signal1]);
            assert!(!signals.is_empty());
        }
    }

    // Tests for at()
    mod test_at {
        use super::*;

        #[test]
        fn test_signals_at() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Temp : 16|8@0- (1,-40) [-40|215] \"\xC2\xB0C\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2]);
            assert_eq!(signals.at(0).unwrap().name(), "RPM");
            assert_eq!(signals.at(1).unwrap().name(), "Temp");
            assert!(signals.at(2).is_none());
        }

        #[test]
        fn test_signals_at_out_of_bounds() {
            let signal = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal]);

            // Valid index
            assert!(signals.at(0).is_some());
            assert_eq!(signals.at(0).unwrap().name(), "RPM");

            // Out of bounds
            assert!(signals.at(1).is_none());
            assert!(signals.at(100).is_none());
            assert!(signals.at(usize::MAX).is_none());
        }
    }

    // Tests for find()
    mod test_find {
        use super::*;

        #[test]
        fn test_signals_find() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Temp : 16|8@0- (1,-40) [-40|215] \"\xC2\xB0C\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2]);
            assert_eq!(signals.find("RPM").unwrap().name(), "RPM");
            assert_eq!(signals.find("Temp").unwrap().name(), "Temp");
            assert!(signals.find("Nonexistent").is_none());
        }

        #[test]
        fn test_signals_find_case_sensitive() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ RPM : 0|16@0+ (0.25,0) [0|8000] \"rpm\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Temp : 16|8@0- (1,-40) [-40|215] \"\xC2\xB0C\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1, signal2]);

            // Exact match
            assert!(signals.find("RPM").is_some());
            assert_eq!(signals.find("RPM").unwrap().name(), "RPM");

            // Case sensitive - should not find
            assert!(signals.find("rpm").is_none());
            assert!(signals.find("Rpm").is_none());

            // Find second signal
            assert!(signals.find("Temp").is_some());
            assert_eq!(signals.find("Temp").unwrap().name(), "Temp");

            // Not found
            assert!(signals.find("Nonexistent").is_none());
            assert!(signals.find("").is_none());
        }

        #[test]
        fn test_signals_find_empty_collection() {
            let signals = Signals::from_slice(&[]);
            assert!(signals.find("RPM").is_none());
            assert!(signals.find("").is_none());
        }

        #[test]
        fn test_signals_find_not_found() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ Signal1 : 0|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();

            let signals = Signals::from_slice(&[signal1]);
            assert!(signals.find("Nonexistent").is_none());
            assert!(signals.find("").is_none());
            assert!(signals.find("signal1").is_none()); // Case sensitive
        }

        #[test]
        fn test_signals_find_first_match() {
            let signal1 = Signal::parse(
                &mut Parser::new(b"SG_ Signal1 : 0|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap();
            let signal2 = Signal::parse(
                &mut Parser::new(b"SG_ Signal1 : 8|8@0+ (1,0) [0|255] \"\"").unwrap(),
            )
            .unwrap(); // Same name (shouldn't happen in practice but test the behavior)

            let signals = Signals::from_slice(&[signal1, signal2]);
            // Should find the first match
            let found = signals.find("Signal1");
            assert!(found.is_some());
            assert_eq!(found.unwrap().start_bit(), 0); // First signal
        }
    }
}