pub struct DbcBuilder { /* private fields */ }Expand description
Builders
Builder for constructing Dbc instances programmatically.
This builder allows you to create DBC files without parsing from a string.
It requires the std feature to be enabled.
§Examples
use dbc_rs::{DbcBuilder, NodesBuilder, MessageBuilder, SignalBuilder, VersionBuilder};
let nodes = NodesBuilder::new()
.add_node("ECM")
.add_node("TCM");
let signal = SignalBuilder::new()
.name("RPM")
.start_bit(0)
.length(16);
let message = MessageBuilder::new()
.id(256)
.name("EngineData")
.dlc(8)
.sender("ECM")
.add_signal(signal);
let dbc = DbcBuilder::new()
.version(VersionBuilder::new().version("1.0"))
.nodes(nodes)
.add_message(message)
.build()?;Implementations§
Source§impl DbcBuilder
impl DbcBuilder
Sourcepub fn validate(self) -> Result<()>
pub fn validate(self) -> Result<()>
Validates the builder without constructing the Dbc.
This method performs all validation checks. Note that this consumes
the builder. If you want to keep the builder after validation, call
build() instead and check the result.
§Examples
use dbc_rs::DbcBuilder;
let builder = DbcBuilder::new();
if builder.validate().is_err() {
// Handle validation error
}Sourcepub fn build(self) -> Result<Dbc>
pub fn build(self) -> Result<Dbc>
Builds the Dbc from the builder.
This method validates all fields and constructs the Dbc instance.
Returns an error if validation fails.
§Examples
use dbc_rs::{DbcBuilder, VersionBuilder, NodesBuilder};
let dbc = DbcBuilder::new()
.version(VersionBuilder::new().version("1.0"))
.nodes(NodesBuilder::new().add_node("ECM"))
.build()?;Source§impl DbcBuilder
impl DbcBuilder
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new empty DbcBuilder.
§Examples
use dbc_rs::{DbcBuilder, VersionBuilder, NodesBuilder, MessageBuilder};
let dbc = DbcBuilder::new()
.version(VersionBuilder::new().version("1.0"))
.nodes(NodesBuilder::new().add_node("ECM"))
.add_message(MessageBuilder::new()
.id(512)
.name("Brake")
.dlc(4)
.sender("ECM"))
.build()?;Sourcepub fn from_dbc(dbc: &Dbc) -> Self
pub fn from_dbc(dbc: &Dbc) -> Self
Creates a DbcBuilder from an existing Dbc.
This allows you to modify an existing DBC file by creating a builder initialized with all data from the provided DBC.
§Arguments
dbc- The existingDbcto create a builder from
§Examples
use dbc_rs::{Dbc, DbcBuilder, MessageBuilder};
let original = Dbc::parse(r#"VERSION "1.0"\nBU_: ECM\n"#)?;
let modified = DbcBuilder::from_dbc(&original)
.add_message(MessageBuilder::new().id(256).name("Msg").dlc(8).sender("ECM"))
.build()?;Source§impl DbcBuilder
impl DbcBuilder
Sourcepub fn version(self, version: VersionBuilder) -> Self
pub fn version(self, version: VersionBuilder) -> Self
Sets the version for the DBC file.
§Examples
use dbc_rs::{DbcBuilder, VersionBuilder};
let vb = VersionBuilder::new().version("1.0");
let builder = DbcBuilder::new()
.version(vb);Sourcepub fn nodes(self, nodes: NodesBuilder) -> Self
pub fn nodes(self, nodes: NodesBuilder) -> Self
Sets the nodes (ECUs) for the DBC file.
§Examples
use dbc_rs::{DbcBuilder, NodesBuilder};
let builder = DbcBuilder::new()
.nodes(NodesBuilder::new().add_node("ECM"));Sourcepub fn add_message(self, message: MessageBuilder) -> Self
pub fn add_message(self, message: MessageBuilder) -> Self
Adds a message to the DBC file.
§Examples
use dbc_rs::{DbcBuilder, MessageBuilder};
let message = MessageBuilder::new()
.id(256)
.name("EngineData")
.dlc(8)
.sender("ECM");
let builder = DbcBuilder::new()
.add_message(message);Sourcepub fn add_messages(
self,
messages: impl IntoIterator<Item = MessageBuilder>,
) -> Self
pub fn add_messages( self, messages: impl IntoIterator<Item = MessageBuilder>, ) -> Self
Adds multiple messages to the DBC file.
§Examples
use dbc_rs::{DbcBuilder, MessageBuilder};
let msg1 = MessageBuilder::new().id(256).name("Msg1").dlc(8).sender("ECM");
let msg2 = MessageBuilder::new().id(512).name("Msg2").dlc(4).sender("TCM");
let builder = DbcBuilder::new()
.add_messages(vec![msg1, msg2]);Sourcepub fn clear_messages(self) -> Self
pub fn clear_messages(self) -> Self
Clears all messages from the builder.
§Examples
use dbc_rs::DbcBuilder;
let builder = DbcBuilder::new()
.clear_messages();