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

mod impls;
mod parse;

#[cfg(feature = "std")]
mod builder;
#[cfg(feature = "std")]
mod std;

use crate::{
    MAX_NODES,
    compat::{Name, Vec},
};
#[cfg(feature = "std")]
pub use builder::ReceiversBuilder;

type ReceiverNames = Vec<Name, { MAX_NODES - 1 }>;

/// Represents the receiver nodes for a signal in a DBC file.
///
/// Per the DBC specification (Section 9.5), receivers are defined as:
/// ```bnf
/// receiver = node_name | 'Vector__XXX' ;
/// receivers = receiver {',' receiver} ;
/// ```
///
/// A signal can have two types of receivers:
/// - **Specific nodes**: A list of specific node names that receive this signal
/// - **None**: No explicit receivers specified (use `Vector__XXX` in DBC output)
///
/// # Examples
///
/// ```rust,no_run
/// use dbc_rs::Dbc;
///
/// let dbc = Dbc::parse(r#"VERSION "1.0"
///
/// BU_: ECM TCM BCM
///
/// BO_ 256 Engine : 8 ECM
///  SG_ RPM : 0|16@1+ (0.25,0) [0|8000] "rpm" Vector__XXX
///  SG_ Temp : 16|8@0- (1,-40) [-40|215] "°C" TCM,BCM
/// "#)?;
///
/// let message = dbc.messages().at(0).unwrap();
///
/// // No specific receiver (Vector__XXX)
/// let rpm_signal = message.signals().find("RPM").unwrap();
/// assert_eq!(rpm_signal.receivers().len(), 0);
///
/// // Specific nodes
/// let temp_signal = message.signals().find("Temp").unwrap();
/// assert_eq!(temp_signal.receivers().len(), 2);
/// assert!(temp_signal.receivers().contains("TCM"));
/// # Ok::<(), dbc_rs::Error>(())
/// ```
///
/// # DBC Format
///
/// In DBC files, receivers are specified after the signal unit:
/// - Comma-separated node names indicate specific receivers (per spec)
/// - `Vector__XXX` indicates no specific receiver
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[allow(clippy::large_enum_variant)]
pub enum Receivers {
    /// Specific receiver nodes - vector of node names.
    Nodes(ReceiverNames),
    /// No explicit receivers specified (serializes as `Vector__XXX`).
    None,
}