Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore!: rename value description types to be more descriptive #9

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

chore!: rename value description types to be more descriptive #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,9 @@ SIG_VALTYPE_ 2000 Signal_8 : 1;
.value_descriptions_for_signal(MessageId(2000), "Signal_3")
.expect("Message comment missing");

let exp = vec![ValDescription {
a: 255.0,
b: "NOP".to_string(),
let exp = vec![ValueDescription {
value: 255.0,
description: "NOP".to_string(),
}];
assert_eq!(exp, val_descriptions);
}
Expand Down Expand Up @@ -421,9 +421,9 @@ pub enum AttributeValueType {

#[derive(Clone, Debug, PartialEq, Getters)]
#[cfg_attr(feature = "serde", derive(Serialize))]
pub struct ValDescription {
a: f64,
b: String,
pub struct ValueDescription {
value: f64,
description: String,
}

#[derive(Clone, Debug, PartialEq, Getters)]
Expand All @@ -447,7 +447,7 @@ pub enum AttributeValue {
#[cfg_attr(feature = "serde", derive(Serialize))]
pub struct ValueTable {
value_table_name: String,
value_descriptions: Vec<ValDescription>,
value_descriptions: Vec<ValueDescription>,
}

#[derive(Clone, Debug, PartialEq, Getters)]
Expand Down Expand Up @@ -562,15 +562,15 @@ pub enum AttributeDefinition {
/// Encoding for signal raw values.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize))]
pub enum ValueDescription {
pub enum ValueDescriptions {
Signal {
message_id: MessageId,
signal_name: String,
value_descriptions: Vec<ValDescription>,
value_descriptions: Vec<ValueDescription>,
},
EnvironmentVariable {
env_var_name: String,
value_descriptions: Vec<ValDescription>,
value_descriptions: Vec<ValueDescription>,
},
}

Expand Down Expand Up @@ -634,7 +634,7 @@ pub struct DBC {
attribute_defaults: Vec<AttributeDefault>,
attribute_values: Vec<AttributeValueForObject>,
/// Encoding for signal raw values
value_descriptions: Vec<ValueDescription>,
value_descriptions: Vec<ValueDescriptions>,
// obsolete + undefined
// category_definitions: Vec<CategoryDefinition>,
// obsolete + undefined
Expand Down Expand Up @@ -727,11 +727,11 @@ impl DBC {
&self,
message_id: MessageId,
signal_name: &str,
) -> Option<&[ValDescription]> {
) -> Option<&[ValueDescription]> {
self.value_descriptions
.iter()
.filter_map(|x| match x {
ValueDescription::Signal {
ValueDescriptions::Signal {
message_id: ref x_message_id,
signal_name: ref x_signal_name,
ref value_descriptions,
Expand Down
64 changes: 32 additions & 32 deletions src/parser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use crate::{
EnvironmentVariable, EnvironmentVariableData, ExtendedMultiplex, ExtendedMultiplexMapping,
Message, MessageId, MessageTransmitter, MultiplexIndicator, Node, Signal,
SignalExtendedValueType, SignalExtendedValueTypeList, SignalGroups, SignalType, SignalTypeRef,
Symbol, Transmitter, ValDescription, ValueDescription, ValueTable, ValueType, Version, DBC,
Symbol, Transmitter, ValueDescription, ValueDescriptions, ValueTable, ValueType, Version, DBC,
};

#[cfg(test)]
Expand Down Expand Up @@ -174,11 +174,11 @@ mod tests {
let def1 = "VAL_ 837 UF_HZ_OI 255 \"NOP\";\n";
let message_id = MessageId(837);
let signal_name = "UF_HZ_OI".to_string();
let val_descriptions = vec![ValDescription {
a: 255.0,
b: "NOP".to_string(),
let val_descriptions = vec![ValueDescription {
value: 255.0,
description: "NOP".to_string(),
}];
let value_description_for_signal1 = ValueDescription::Signal {
let value_description_for_signal1 = ValueDescriptions::Signal {
message_id,
signal_name,
value_descriptions: val_descriptions,
Expand All @@ -192,11 +192,11 @@ mod tests {
fn value_description_for_env_var_test() {
let def1 = "VAL_ MY_ENV_VAR 255 \"NOP\";\n";
let env_var_name = "MY_ENV_VAR".to_string();
let val_descriptions = vec![ValDescription {
a: 255.0,
b: "NOP".to_string(),
let val_descriptions = vec![ValueDescription {
value: 255.0,
description: "NOP".to_string(),
}];
let value_env_var1 = ValueDescription::EnvironmentVariable {
let value_env_var1 = ValueDescriptions::EnvironmentVariable {
env_var_name,
value_descriptions: val_descriptions,
};
Expand Down Expand Up @@ -455,9 +455,9 @@ mod tests {
#[test]
fn value_description_test() {
let def = "2 \"ABC\"\n";
let exp = ValDescription {
a: 2f64,
b: "ABC".to_string(),
let exp = ValueDescription {
value: 2f64,
description: "ABC".to_string(),
};
let (_, val_desc) = value_description(def).unwrap();
assert_eq!(exp, val_desc);
Expand All @@ -469,13 +469,13 @@ mod tests {
let exp = ValueTable {
value_table_name: "Tst".to_string(),
value_descriptions: vec![
ValDescription {
a: 2f64,
b: "ABC".to_string(),
ValueDescription {
value: 2f64,
description: "ABC".to_string(),
},
ValDescription {
a: 1f64,
b: "Test A".to_string(),
ValueDescription {
value: 1f64,
description: "Test A".to_string(),
},
],
};
Expand All @@ -488,9 +488,9 @@ mod tests {
let def = "VAL_TABLE_ Tst 2 \"ABC\";\n";
let exp = ValueTable {
value_table_name: "Tst".to_string(),
value_descriptions: vec![ValDescription {
a: 2f64,
b: "ABC".to_string(),
value_descriptions: vec![ValueDescription {
value: 2f64,
description: "ABC".to_string(),
}],
};
let (_, val_table) = value_table(def).unwrap();
Expand Down Expand Up @@ -940,20 +940,20 @@ fn comment(s: &str) -> IResult<&str, Comment> {
Ok((s, comment))
}

fn value_description(s: &str) -> IResult<&str, ValDescription> {
let (s, a) = double(s)?;
fn value_description(s: &str) -> IResult<&str, ValueDescription> {
let (s, value) = double(s)?;
let (s, _) = ms1(s)?;
let (s, b) = char_string(s)?;
let (s, description) = char_string(s)?;
Ok((
s,
ValDescription {
a,
b: b.to_string(),
ValueDescription {
value,
description: description.to_string(),
},
))
}

fn value_description_for_signal(s: &str) -> IResult<&str, ValueDescription> {
fn value_description_for_signal(s: &str) -> IResult<&str, ValueDescriptions> {
let (s, _) = ms0(s)?;
let (s, _) = tag("VAL_")(s)?;
let (s, _) = ms1(s)?;
Expand All @@ -966,15 +966,15 @@ fn value_description_for_signal(s: &str) -> IResult<&str, ValueDescription> {
)(s)?;
Ok((
s,
ValueDescription::Signal {
ValueDescriptions::Signal {
message_id,
signal_name,
value_descriptions: value_descriptions.0,
},
))
}

fn value_description_for_env_var(s: &str) -> IResult<&str, ValueDescription> {
fn value_description_for_env_var(s: &str) -> IResult<&str, ValueDescriptions> {
let (s, _) = ms0(s)?;
let (s, _) = tag("VAL_")(s)?;
let (s, _) = ms1(s)?;
Expand All @@ -985,14 +985,14 @@ fn value_description_for_env_var(s: &str) -> IResult<&str, ValueDescription> {
)(s)?;
Ok((
s,
ValueDescription::EnvironmentVariable {
ValueDescriptions::EnvironmentVariable {
env_var_name,
value_descriptions: value_descriptions.0,
},
))
}

fn value_descriptions(s: &str) -> IResult<&str, ValueDescription> {
fn value_descriptions(s: &str) -> IResult<&str, ValueDescriptions> {
let (s, _) = multispace0(s)?;
let (s, vd) = alt((value_description_for_signal, value_description_for_env_var))(s)?;
let (s, _) = line_ending(s)?;
Expand Down