pub struct DbcBuilder { /* private fields */ }Expand description
Builder for constructing Dbc instances programmatically.
This builder allows you to create DBC files without parsing from a string.
It requires the alloc feature to be enabled.
§Examples
use dbc_rs::{DbcBuilder, NodesBuilder, MessageBuilder, SignalBuilder, VersionBuilder};
let nodes = NodesBuilder::new()
.add_node("ECM")
.add_node("TCM")
.build()?;
let signal = SignalBuilder::new()
.name("RPM")
.start_bit(0)
.length(16)
.build()?;
let message = MessageBuilder::new()
.id(256)
.name("EngineData")
.dlc(8)
.sender("ECM")
.add_signal(signal)
.build()?;
let dbc = DbcBuilder::new()
.version(VersionBuilder::new().version("1.0").build()?)
.nodes(nodes)
.add_message(message)
.build()?;Implementations§
Source§impl DbcBuilder
impl DbcBuilder
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new DbcBuilder with default values.
§Examples
use dbc_rs::DbcBuilder;
let builder = DbcBuilder::new();Sourcepub fn version(self, version: Version<'static>) -> Self
pub fn version(self, version: Version<'static>) -> Self
Sets the version for the DBC file.
§Examples
use dbc_rs::{DbcBuilder, VersionBuilder};
let builder = DbcBuilder::new()
.version(VersionBuilder::new().version("1.0").build()?);Sourcepub fn nodes(self, nodes: Nodes<'static>) -> Self
pub fn nodes(self, nodes: Nodes<'static>) -> 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").build()?);Sourcepub fn add_message(self, message: Message<'static>) -> Self
pub fn add_message(self, message: Message<'static>) -> 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")
.build()?;
let builder = DbcBuilder::new()
.add_message(message);Sourcepub fn add_messages(
self,
messages: impl IntoIterator<Item = Message<'static>>,
) -> Self
pub fn add_messages( self, messages: impl IntoIterator<Item = Message<'static>>, ) -> Self
Adds multiple messages to the DBC file.
§Examples
use dbc_rs::{DbcBuilder, MessageBuilder};
let messages = vec![
MessageBuilder::new().id(256).name("Msg1").dlc(8).sender("ECM").build()?,
MessageBuilder::new().id(512).name("Msg2").dlc(4).sender("TCM").build()?,
];
let builder = DbcBuilder::new()
.add_messages(messages);Sourcepub fn messages(self, messages: Vec<Message<'static>>) -> Self
pub fn messages(self, messages: Vec<Message<'static>>) -> Self
Sets all messages for the DBC file, replacing any existing messages.
§Examples
use dbc_rs::{DbcBuilder, MessageBuilder};
let messages = vec![
MessageBuilder::new().id(256).name("Msg1").dlc(8).sender("ECM").build()?,
];
let builder = DbcBuilder::new()
.messages(messages);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();Sourcepub fn validate(self) -> Result<Self>
pub fn validate(self) -> Result<Self>
Validates the builder without constructing the Dbc.
This method performs all validation checks but returns the builder
instead of constructing the Dbc. Useful for checking if the builder
is valid before calling build().
§Examples
use dbc_rs::DbcBuilder;
let builder = DbcBuilder::new();
if builder.validate().is_err() {
// Handle validation error
}Sourcepub fn build(self) -> Result<Dbc<'static>>
pub fn build(self) -> Result<Dbc<'static>>
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").build()?)
.nodes(NodesBuilder::new().add_node("ECM").build()?)
.build()?;