dbc-rs 0.4.2

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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
use super::SignalBuilder;
use crate::{ByteOrder, Error, ReceiversBuilder, Result, Signal, required_field};

type SignalFields = (
    String,
    u16,
    u16,
    ByteOrder,
    bool,
    f64,
    f64,
    f64,
    f64,
    Option<String>,
    ReceiversBuilder,
    Option<String>,
);

impl SignalBuilder {
    fn extract_fields(&self) -> Result<SignalFields> {
        let name = required_field!(self.name.clone(), Error::signal(Error::SIGNAL_NAME_EMPTY))?;
        let start_bit = required_field!(
            self.start_bit,
            Error::signal(Error::SIGNAL_START_BIT_REQUIRED)
        )?;
        let length = required_field!(self.length, Error::signal(Error::SIGNAL_LENGTH_REQUIRED))?;
        let byte_order = required_field!(
            self.byte_order,
            Error::signal(Error::SIGNAL_BYTE_ORDER_REQUIRED)
        )?;
        let unsigned = required_field!(
            self.unsigned,
            Error::signal(Error::SIGNAL_UNSIGNED_REQUIRED)
        )?;
        let factor = required_field!(self.factor, Error::signal(Error::SIGNAL_FACTOR_REQUIRED))?;
        let offset = required_field!(self.offset, Error::signal(Error::SIGNAL_OFFSET_REQUIRED))?;
        let min = required_field!(self.min, Error::signal(Error::SIGNAL_MIN_REQUIRED))?;
        let max = required_field!(self.max, Error::signal(Error::SIGNAL_MAX_REQUIRED))?;
        Ok((
            name,
            start_bit,
            length,
            byte_order,
            unsigned,
            factor,
            offset,
            min,
            max,
            self.unit.clone(),
            self.receivers.clone(),
            self.comment.clone(),
        ))
    }

    #[must_use = "validation result should be checked"]
    pub fn validate(self) -> Result<Self> {
        let (
            name,
            start_bit,
            length,
            byte_order,
            unsigned,
            factor,
            offset,
            min,
            max,
            unit,
            receivers,
            comment,
        ) = self.extract_fields()?;

        // Validate start_bit: must be between 0 and 511 (CAN FD maximum is 512 bits)
        if start_bit > 511 {
            return Err(Error::signal(Error::SIGNAL_PARSE_INVALID_START_BIT));
        }

        // Validate that start_bit + length doesn't exceed CAN FD maximum (512 bits)
        // Note: This is a basic sanity check. Full validation (including name, min/max,
        // message DLC bounds, and overlap detection) happens in build() when the signal
        // is actually constructed, to avoid duplicate validation calls.
        let end_bit = start_bit + length - 1; // -1 because length includes the start bit
        if end_bit >= 512 {
            return Err(Error::signal(Error::SIGNAL_EXTENDS_BEYOND_MESSAGE));
        }
        Ok(Self {
            name: Some(name),
            start_bit: Some(start_bit),
            length: Some(length),
            byte_order: Some(byte_order),
            unsigned: Some(unsigned),
            factor: Some(factor),
            offset: Some(offset),
            min: Some(min),
            max: Some(max),
            unit,
            receivers,
            comment,
        })
    }

    /// Builds and validates the `Signal`.
    ///
    /// Consumes the builder and returns a fully constructed and validated [`Signal`].
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - Any required field is missing (name, start_bit, length, byte_order, unsigned, factor, offset, min, max)
    /// - Name exceeds maximum length (32 characters)
    /// - Signal length is invalid (zero or exceeds 64 bits)
    /// - Min value exceeds max value
    /// - Receivers fail to build
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use dbc_rs::{SignalBuilder, ByteOrder, ReceiversBuilder};
    ///
    /// let signal = SignalBuilder::new()
    ///     .name("EngineSpeed")
    ///     .start_bit(0)
    ///     .length(16)
    ///     .byte_order(ByteOrder::LittleEndian)
    ///     .unsigned(true)
    ///     .factor(0.25)
    ///     .offset(0.0)
    ///     .min(0.0)
    ///     .max(8000.0)
    ///     .unit("rpm")
    ///     .receivers(ReceiversBuilder::new().add_node("TCM"))
    ///     .build()?;
    ///
    /// assert_eq!(signal.name(), "EngineSpeed");
    /// assert_eq!(signal.factor(), 0.25);
    /// # Ok::<(), dbc_rs::Error>(())
    /// ```
    pub fn build(self) -> Result<Signal> {
        let (
            name,
            start_bit,
            length,
            byte_order,
            unsigned,
            factor,
            offset,
            min,
            max,
            unit,
            receivers,
            comment,
        ) = self.extract_fields()?;
        // Build receivers first (receivers is already ReceiversBuilder)
        let built_receivers = receivers.build()?;
        // Validate before construction
        Signal::validate(&name, length, min, max)?;
        // Use Cow::Owned for owned strings (no leak needed)
        Ok(Signal::new(
            name.into(),
            start_bit,
            length,
            byte_order,
            unsigned,
            factor,
            offset,
            min,
            max,
            unit.map(|u| u.into()),
            built_receivers,
            comment.map(|c| c.into()),
        ))
    }
}

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

    fn minimal_signal() -> SignalBuilder {
        SignalBuilder::new()
            .name("TestSignal")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
    }

    #[test]
    fn test_signal_builder_new() {
        let builder = SignalBuilder::new();
        // Default builder should be empty
        assert!(builder.build().is_err());
    }

    #[test]
    fn test_signal_builder_default() {
        let builder = SignalBuilder::default();
        assert!(builder.build().is_err());
    }

    #[test]
    fn test_signal_builder_missing_name() {
        let result = SignalBuilder::new()
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_start_bit() {
        let result = SignalBuilder::new()
            .name("Test")
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_length() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_byte_order() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_unsigned() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_factor() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_offset() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_min() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_missing_max() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_validate_valid() {
        let builder = minimal_signal();
        let result = builder.validate();
        assert!(result.is_ok());
    }

    #[test]
    fn test_signal_builder_validate_start_bit_too_large() {
        let builder = SignalBuilder::new()
            .name("Test")
            .start_bit(512) // > 511
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none());

        let result = builder.validate();
        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_validate_extends_beyond_512_bits() {
        let builder = SignalBuilder::new()
            .name("Test")
            .start_bit(505)
            .length(16) // 505 + 16 - 1 = 520 >= 512
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none());

        let result = builder.validate();
        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_validate_at_boundary() {
        // 504 + 8 - 1 = 511 < 512, should pass
        let builder = SignalBuilder::new()
            .name("Test")
            .start_bit(504)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none());

        let result = builder.validate();
        assert!(result.is_ok());
    }

    #[test]
    fn test_signal_builder_invalid_min_max_range() {
        // min > max should fail
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(8)
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(100.0)
            .max(0.0) // min > max
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_zero_length() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(0) // Invalid
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }

    #[test]
    fn test_signal_builder_length_too_large() {
        let result = SignalBuilder::new()
            .name("Test")
            .start_bit(0)
            .length(513) // > 512
            .byte_order(ByteOrder::LittleEndian)
            .unsigned(true)
            .factor(1.0)
            .offset(0.0)
            .min(0.0)
            .max(255.0)
            .receivers(ReceiversBuilder::new().none())
            .build();

        assert!(result.is_err());
    }
}