Struct ValueDescriptionsBuilder

Source

pub struct ValueDescriptionsBuilder { /* private fields */ }

Expand description

Builder for creating ValueDescriptions programmatically.

This builder allows you to construct value descriptions when building DBC files programmatically. It validates that entries are within limits.

§Examples

use dbc_rs::ValueDescriptionsBuilder;

let value_descriptions = ValueDescriptionsBuilder::new()
    .add_entry(0, "Park")
    .add_entry(1, "Reverse")
    .add_entry(2, "Neutral")
    .add_entry(3, "Drive")
    .build()?;

assert_eq!(value_descriptions.get(0), Some("Park"));
assert_eq!(value_descriptions.get(1), Some("Reverse"));

§Validation

The builder validates:

Maximum of 64 value descriptions (MAX_VALUE_DESCRIPTIONS)

§Feature Requirements

This builder requires the std feature to be enabled.

Implementations§

Source §

impl ValueDescriptionsBuilder

Source

pub fn new() -> Self

Creates a new ValueDescriptionsBuilder with an empty entry list.

§Examples

use dbc_rs::ValueDescriptionsBuilder;

let builder = ValueDescriptionsBuilder::new();
let value_descriptions = builder.build()?;
assert!(value_descriptions.is_empty());

Source

pub fn add_entry(self, value: u64, description: impl AsRef<str>) -> Self

Adds a value-description pair to the builder.

§Arguments

value - The numeric value (u64)
description - The human-readable description

§Examples

use dbc_rs::ValueDescriptionsBuilder;

let builder = ValueDescriptionsBuilder::new()
    .add_entry(0, "Off")
    .add_entry(1, "On");

Source

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

Builds the ValueDescriptions from the builder.

§Errors

Returns an error if the number of entries exceeds the maximum allowed.

§Examples

use dbc_rs::ValueDescriptionsBuilder;

let value_descriptions = ValueDescriptionsBuilder::new()
    .add_entry(0, "Park")
    .add_entry(1, "Drive")
    .build()?;