DbcBuilder

Struct DbcBuilder 

Source
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

Source

pub fn new() -> Self

Creates a new DbcBuilder with default values.

§Examples
use dbc_rs::DbcBuilder;

let builder = DbcBuilder::new();
Source

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()?);
Source

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()?);
Source

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);
Source

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);
Source

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);
Source

pub fn clear_messages(self) -> Self

Clears all messages from the builder.

§Examples
use dbc_rs::DbcBuilder;

let builder = DbcBuilder::new()
    .clear_messages();
Source

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
}
Source

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()?;

Trait Implementations§

Source§

impl Debug for DbcBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DbcBuilder

Source§

fn default() -> DbcBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.