Struct SignalBuilder 

pub struct SignalBuilder { /* private fields */ }

Builder for creating CAN signals programmatically.

Use this builder to construct Signal instances with validated properties. Required fields (name, start_bit, length) must be set before calling build().

Examples

use dbc_rs::{SignalBuilder, ByteOrder};

let signal = SignalBuilder::new()
    .name("EngineRPM")
    .start_bit(0)
    .length(16)
    .byte_order(ByteOrder::LittleEndian)
    .unsigned(true)
    .factor(0.25)
    .offset(0.0)
    .min(0.0)
    .max(8000.0)
    .unit("rpm")
    .build()?;

Implementations

impl SignalBuilder

pub fn validate(self) -> Result<Self>

pub fn build(self) -> Result<Signal>

Builds and validates the Signal.

Consumes the builder and returns a fully constructed and validated Signal.

Errors

Returns an error if:

• Any required field is missing (name, start_bit, length, byte_order, unsigned, factor, offset, min, max)
• Name exceeds maximum length (32 characters)
• Signal length is invalid (zero or exceeds 64 bits)
• Min value exceeds max value
• Receivers fail to build

Examples

use dbc_rs::{SignalBuilder, ByteOrder, ReceiversBuilder};

let signal = SignalBuilder::new()
    .name("EngineSpeed")
    .start_bit(0)
    .length(16)
    .byte_order(ByteOrder::LittleEndian)
    .unsigned(true)
    .factor(0.25)
    .offset(0.0)
    .min(0.0)
    .max(8000.0)
    .unit("rpm")
    .receivers(ReceiversBuilder::new().add_node("TCM"))
    .build()?;

assert_eq!(signal.name(), "EngineSpeed");
assert_eq!(signal.factor(), 0.25);

impl SignalBuilder

pub fn new() -> Self

Creates a new SignalBuilder with no fields set.

Examples

use dbc_rs::SignalBuilder;

let builder = SignalBuilder::new();
// Must set name, start_bit, length, and byte_order before building

pub fn name(self, name: impl AsRef<str>) -> Self

Sets the signal name.

pub fn unit(self, unit: impl AsRef<str>) -> Self

Sets the unit of measurement for this signal (e.g., “km/h”, “rpm”, “°C”).

pub fn comment(self, comment: impl AsRef<str>) -> Self

Sets the comment text for this signal (from CM_ SG_ entry).

pub fn start_bit(self, start_bit: u16) -> Self

Sets the start bit position of the signal in the CAN message payload.

pub fn length(self, length: u16) -> Self

Sets the length of the signal in bits.

pub fn byte_order(self, byte_order: ByteOrder) -> Self

Sets the byte order (endianness) of the signal.

pub fn unsigned(self, unsigned: bool) -> Self

Sets whether the signal is unsigned (true) or signed (false).

pub fn factor(self, factor: f64) -> Self

Sets the scaling factor for converting raw values to physical values (physical = raw * factor + offset).

pub fn offset(self, offset: f64) -> Self

Sets the offset for converting raw values to physical values (physical = raw * factor + offset).

pub fn min(self, min: f64) -> Self

Sets the minimum physical value for this signal.

pub fn max(self, max: f64) -> Self

Sets the maximum physical value for this signal.

pub fn receivers(self, receivers: ReceiversBuilder) -> Self

Sets the receivers (ECU nodes) that subscribe to this signal.

Arguments

• receivers - A ReceiversBuilder specifying which nodes receive this signal

Examples

use dbc_rs::{SignalBuilder, ReceiversBuilder};

let receivers = ReceiversBuilder::new()
    .add_node("ECU1")
    .add_node("ECU2");

let builder = SignalBuilder::new()
    .receivers(receivers);

Trait Implementations

impl Clone for SignalBuilder

fn clone(&self) -> SignalBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalBuilder

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

Formats the value using the given formatter.

impl Default for SignalBuilder

fn default() -> Self

Returns the “default value” for a type.