Struct ValueDescriptionsList 

pub struct ValueDescriptionsList<'a> { /* private fields */ }

Encapsulates the value descriptions map for a DBC

Value descriptions map signal values to human-readable text descriptions. They can be message-specific (keyed by message_id and signal_name) or global (keyed by None and signal_name, applying to all signals with that name).

Implementations

impl<'a> ValueDescriptionsList<'a>

pub fn iter( &self, ) -> impl Iterator<Item = ((Option<u32>, &'a str), &ValueDescriptions<'a>)> + '_

Get an iterator over all value descriptions

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse(r#"VERSION "1.0"

BU_: ECM

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

VAL_ 100 Gear 0 "Park" 1 "Drive" ;"#)?;
for ((message_id, signal_name), value_descriptions) in dbc.value_descriptions().iter() {
    println!("Message {:?}, Signal {}: {} entries", message_id, signal_name, value_descriptions.len());
}

pub fn len(&self) -> usize

Get the number of value description entries

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse(r#"VERSION "1.0"

BU_: ECM

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

VAL_ 100 Gear 0 "Park" 1 "Drive" ;"#)?;
assert_eq!(dbc.value_descriptions().len(), 1);

pub fn is_empty(&self) -> bool

Returns true if there are no value descriptions

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse("VERSION \"1.0\"\n\nBU_: ECM")?;
assert!(dbc.value_descriptions().is_empty());

pub fn for_signal( &self, message_id: u32, signal_name: &str, ) -> Option<&ValueDescriptions<'a>>

Get value descriptions for a specific signal

This method first tries to find a message-specific value description, then falls back to a global value description (if message_id is None in the map).

Arguments

• message_id - The message ID
• signal_name - The signal name

Examples

use dbc_rs::Dbc;

let dbc = Dbc::parse(r#"VERSION "1.0"

BU_: ECM

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

VAL_ 100 Gear 0 "Park" 1 "Drive" ;"#)?;
if let Some(value_descriptions) = dbc.value_descriptions().for_signal(100, "Gear") {
    assert_eq!(value_descriptions.get(0), Some("Park"));
}

Trait Implementations

impl<'a> Clone for ValueDescriptionsList<'a>

fn clone(&self) -> ValueDescriptionsList<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ValueDescriptionsList<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ValueDescriptionsList<'a>

fn default() -> ValueDescriptionsList<'a>

Returns the “default value” for a type.

impl<'a> Hash for ValueDescriptionsList<'a>

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<'a> PartialEq for ValueDescriptionsList<'a>

fn eq(&self, other: &ValueDescriptionsList<'a>) -> 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<'a> Eq for ValueDescriptionsList<'a>

impl<'a> StructuralPartialEq for ValueDescriptionsList<'a>