Struct ExtendedMultiplexingBuilder

Source

pub struct ExtendedMultiplexingBuilder { /* private fields */ }

Expand description

Builder for creating ExtendedMultiplexing programmatically.

This builder allows you to construct extended multiplexing entries when building DBC files programmatically. Extended multiplexing (SG_MUL_VAL_) entries define which multiplexer switch values activate specific multiplexed signals.

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

// Build an extended multiplexing entry
let ext_mux = ExtendedMultiplexingBuilder::new()
    .message_id(500)
    .signal_name("Signal_A")
    .multiplexer_switch("Mux1")
    .add_value_range(0, 5)
    .add_value_range(10, 15)
    .build()?;

assert_eq!(ext_mux.message_id(), 500);
assert_eq!(ext_mux.signal_name(), "Signal_A");
assert_eq!(ext_mux.multiplexer_switch(), "Mux1");

§Feature Requirements

This builder requires the std feature to be enabled.

Implementations§

Source §

impl ExtendedMultiplexingBuilder

Source

pub fn new() -> Self

Creates a new ExtendedMultiplexingBuilder with no fields set.

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

let builder = ExtendedMultiplexingBuilder::new();
// Must set message_id, signal_name, multiplexer_switch, and at least one value range before building

Source

pub fn message_id(self, message_id: u32) -> Self

Sets the message ID.

§Arguments

message_id - The CAN message ID this extended multiplexing entry applies to

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

let builder = ExtendedMultiplexingBuilder::new()
    .message_id(500);

Source

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

Sets the signal name.

§Arguments

signal_name - The name of the multiplexed signal

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

let builder = ExtendedMultiplexingBuilder::new()
    .signal_name("Signal_A");

Source

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

Sets the multiplexer switch name.

§Arguments

multiplexer_switch - The name of the multiplexer switch signal

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

let builder = ExtendedMultiplexingBuilder::new()
    .multiplexer_switch("Mux1");

Source

pub fn add_value_range(self, min: u64, max: u64) -> Self

Adds a value range to the extended multiplexing entry.

§Arguments

min - The minimum switch value (inclusive)
max - The maximum switch value (inclusive)

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

let builder = ExtendedMultiplexingBuilder::new()
    .add_value_range(0, 5)
    .add_value_range(10, 15);

Source

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

Builds the ExtendedMultiplexing from the builder configuration.

This validates that all required fields have been set and constructs an ExtendedMultiplexing instance.

§Returns

Returns Ok(ExtendedMultiplexing) if successful, or Err(Error) if:

message_id is not set
signal_name is not set or invalid
multiplexer_switch is not set or invalid
No value ranges have been added
Any name exceeds MAX_NAME_SIZE

§Examples

use dbc_rs::ExtendedMultiplexingBuilder;

let ext_mux = ExtendedMultiplexingBuilder::new()
    .message_id(500)
    .signal_name("Signal_A")
    .multiplexer_switch("Mux1")
    .add_value_range(0, 5)
    .build()?;

§Errors

use dbc_rs::ExtendedMultiplexingBuilder;

// Missing message_id
let result = ExtendedMultiplexingBuilder::new()
    .signal_name("Signal_A")
    .multiplexer_switch("Mux1")
    .add_value_range(0, 5)
    .build();
assert!(result.is_err());

// Missing value ranges
let result = ExtendedMultiplexingBuilder::new()
    .message_id(500)
    .signal_name("Signal_A")
    .multiplexer_switch("Mux1")
    .build();
assert!(result.is_err());