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

use crate::{
    BitTiming, ExtendedMultiplexing, MAX_EXTENDED_MULTIPLEXING, Nodes, Version,
    compat::{Comment, Vec},
};

type ExtendedMultiplexings = Vec<ExtendedMultiplexing, { MAX_EXTENDED_MULTIPLEXING }>;

// Index for fast extended multiplexing lookup by (message_id, signal_name)
// Maps to indices into the extended_multiplexing vec
mod ext_mux_index;
use ext_mux_index::ExtMuxIndex;

// Module declarations
#[cfg(feature = "attributes")]
mod attributes_map;
mod messages;
mod value_descriptions_map;

// Include modules for additional functionality
#[cfg(feature = "std")]
mod builder;
mod decode;
mod encode;
mod impls;
mod parse;
#[cfg(feature = "std")]
mod std;
mod validate;

// Re-exports
#[cfg(feature = "attributes")]
pub use attributes_map::{AttributeDefaultsMap, AttributeDefinitionsMap, AttributeValuesMap};
#[cfg(feature = "std")]
pub use builder::DbcBuilder;
pub use decode::DecodedSignal;
use messages::Messages;
use validate::Validate;
use value_descriptions_map::ValueDescriptionsMap;

/// Represents a complete DBC (CAN database) file.
///
/// A `Dbc` contains:
/// - An optional version string
/// - A list of nodes (ECUs)
/// - A collection of messages with their signals
///
/// # Examples
///
/// ```rust,no_run
/// use dbc_rs::Dbc;
///
/// let dbc_content = r#"VERSION "1.0"
///
/// BU_: ECM TCM
///
/// BO_ 256 EngineData : 8 ECM
///  SG_ RPM : 0|16@0+ (0.25,0) [0|8000] "rpm" TCM
/// "#;
///
/// let dbc = Dbc::parse(dbc_content)?;
/// println!("Parsed {} messages", dbc.messages().len());
/// # Ok::<(), dbc_rs::Error>(())
/// ```
#[derive(Debug, Clone)]
pub struct Dbc {
    version: Option<Version>,
    bit_timing: Option<BitTiming>,
    nodes: Nodes,
    messages: Messages,
    value_descriptions: ValueDescriptionsMap,
    extended_multiplexing: ExtendedMultiplexings,
    /// Index for O(1) extended multiplexing lookup by (message_id, signal_name)
    ext_mux_index: ExtMuxIndex,
    /// Database-level comment from CM_ (general comment)
    comment: Option<Comment>,
    /// Attribute definitions (BA_DEF_)
    #[cfg(feature = "attributes")]
    attribute_definitions: AttributeDefinitionsMap,
    /// Attribute default values (BA_DEF_DEF_)
    #[cfg(feature = "attributes")]
    attribute_defaults: AttributeDefaultsMap,
    /// Attribute values (BA_)
    #[cfg(feature = "attributes")]
    attribute_values: AttributeValuesMap,
}