Struct ValueDescriptions 

pub struct ValueDescriptions { /* private fields */ }

Value descriptions for a signal.

Maps numeric signal values to human-readable text descriptions. For example, a gear position signal might map:

• 0 -> “Park”
• 1 -> “Reverse”
• 2 -> “Neutral”
• 3 -> “Drive”

Examples

use dbc_rs::Dbc;

let dbc_content = r#"VERSION "1.0"

BU_: ECM

BO_ 100 EngineData : 8 ECM
 SG_ GearPosition : 0|8@1+ (1,0) [0|5] "" *

VAL_ 100 GearPosition 0 "Park" 1 "Reverse" 2 "Neutral" 3 "Drive" ;
"#;

let dbc = Dbc::parse(dbc_content)?;
let message = dbc.messages().iter().find(|m| m.id() == 100).unwrap();
let signal = message.signals().find("GearPosition").unwrap();

if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
    if let Some(description) = value_descriptions.get(0) {
        println!("Value 0 means: {}", description);
    }
}

Implementations

impl ValueDescriptions

pub fn get(&self, value: u64) -> Option<&str>

Get the description for a numeric value

Examples

if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
    if let Some(desc) = value_descriptions.get(0) {
        println!("Value 0: {}", desc);
    }
}

pub fn len(&self) -> usize

Get the number of value descriptions

pub fn is_empty(&self) -> bool

Check if there are any value descriptions

pub fn at(&self, index: usize) -> Option<(u64, &str)>

Get a value description by index.

Returns None if the index is out of bounds.

Arguments

• index - The zero-based index of the value description

Examples

if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
    if let Some((value, description)) = value_descriptions.at(0) {
        println!("Value {}: {}", value, description);
    }
}

pub fn iter(&self) -> ValueDescriptionsIter<'_>

Iterate over all value descriptions

Examples

if let Some(value_descriptions) = dbc.value_descriptions_for_signal(message.id(), signal.name()) {
    for (value, description) in value_descriptions.iter() {
        println!("{} -> {}", value, description);
    }
}

Trait Implementations

impl Clone for ValueDescriptions

fn clone(&self) -> ValueDescriptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueDescriptions

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

Formats the value using the given formatter.

impl Hash for ValueDescriptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ValueDescriptions

fn eq(&self, other: &ValueDescriptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ValueDescriptions

impl StructuralPartialEq for ValueDescriptions