Struct ObdSignal

#[non_exhaustive]
pub struct ObdSignal {
    pub pid_response_length: i32,
    pub service_mode: i32,
    pub pid: i32,
    pub scaling: f64,
    pub offset: f64,
    pub start_byte: i32,
    pub byte_length: i32,
    pub bit_right_shift: i32,
    pub bit_mask_length: Option<i32>,
    pub is_signed: Option<bool>,
    pub signal_value_type: Option<SignalValueType>,
}

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pid_response_length: i32

The length of the requested data.

service_mode: i32

The mode of operation (diagnostic service) in a message.

pid: i32

The diagnostic code used to request data from a vehicle for this signal.

scaling: f64

A multiplier used to decode the message.

offset: f64

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

start_byte: i32

Indicates the beginning of the message.

byte_length: i32

The length of a message.

bit_right_shift: i32

The number of positions to shift bits in the message.

bit_mask_length: Option<i32>

The number of bits to mask in a message.

is_signed: Option<bool>

Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.

signal_value_type: Option<SignalValueType>

The value type of the signal. The default value is INTEGER.

Implementations

impl ObdSignal

pub fn pid_response_length(&self) -> i32

The length of the requested data.

pub fn service_mode(&self) -> i32

The mode of operation (diagnostic service) in a message.

pub fn pid(&self) -> i32

The diagnostic code used to request data from a vehicle for this signal.

pub fn scaling(&self) -> f64

A multiplier used to decode the message.

pub fn offset(&self) -> f64

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

pub fn start_byte(&self) -> i32

Indicates the beginning of the message.

pub fn byte_length(&self) -> i32

The length of a message.

pub fn bit_right_shift(&self) -> i32

The number of positions to shift bits in the message.

pub fn bit_mask_length(&self) -> Option<i32>

The number of bits to mask in a message.

pub fn is_signed(&self) -> Option<bool>

Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.

pub fn signal_value_type(&self) -> Option<&SignalValueType>

The value type of the signal. The default value is INTEGER.

impl ObdSignal

pub fn builder() -> ObdSignalBuilder

Creates a new builder-style object to manufacture ObdSignal.

Trait Implementations

impl Clone for ObdSignal

fn clone(&self) -> ObdSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObdSignal

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

Formats the value using the given formatter.

impl PartialEq for ObdSignal

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

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

const 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 StructuralPartialEq for ObdSignal