dbc-rs 0.5.0

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

use super::BitTiming;

impl BitTiming {
    /// Creates a new empty BitTiming (most common case).
    #[must_use]
    pub(crate) const fn new() -> Self {
        Self {
            baudrate: None,
            btr1: None,
            btr2: None,
        }
    }

    /// Creates a new BitTiming with baudrate only.
    #[must_use]
    pub const fn with_baudrate(baudrate: u32) -> Self {
        Self {
            baudrate: Some(baudrate),
            btr1: None,
            btr2: None,
        }
    }

    /// Creates a new BitTiming with all parameters.
    #[must_use]
    pub const fn with_btr(baudrate: u32, btr1: u32, btr2: u32) -> Self {
        Self {
            baudrate: Some(baudrate),
            btr1: Some(btr1),
            btr2: Some(btr2),
        }
    }

    /// Returns the baudrate in kbps, if specified.
    #[must_use]
    pub const fn baudrate(&self) -> Option<u32> {
        self.baudrate
    }

    /// Returns the BTR1 (Bus Timing Register 1) value, if specified.
    #[must_use]
    pub const fn btr1(&self) -> Option<u32> {
        self.btr1
    }

    /// Returns the BTR2 (Bus Timing Register 2) value, if specified.
    #[must_use]
    pub const fn btr2(&self) -> Option<u32> {
        self.btr2
    }

    /// Returns true if the bit timing section is empty (no values).
    #[must_use]
    pub const fn is_empty(&self) -> bool {
        self.baudrate.is_none()
    }
}