Struct ObdSignalBuilder

#[non_exhaustive]
pub struct ObdSignalBuilder { /* private fields */ }

A builder for ObdSignal.

Implementations

impl ObdSignalBuilder

pub fn pid_response_length(self, input: i32) -> Self

The length of the requested data.

This field is required.

pub fn set_pid_response_length(self, input: Option<i32>) -> Self

The length of the requested data.

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

The length of the requested data.

pub fn service_mode(self, input: i32) -> Self

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

This field is required.

pub fn set_service_mode(self, input: Option<i32>) -> Self

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

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

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

pub fn pid(self, input: i32) -> Self

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

This field is required.

pub fn set_pid(self, input: Option<i32>) -> Self

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

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

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

pub fn scaling(self, input: f64) -> Self

A multiplier used to decode the message.

This field is required.

pub fn set_scaling(self, input: Option<f64>) -> Self

A multiplier used to decode the message.

pub fn get_scaling(&self) -> &Option<f64>

A multiplier used to decode the message.

pub fn offset(self, input: f64) -> Self

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

This field is required.

pub fn set_offset(self, input: Option<f64>) -> Self

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

pub fn get_offset(&self) -> &Option<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, input: i32) -> Self

Indicates the beginning of the message.

This field is required.

pub fn set_start_byte(self, input: Option<i32>) -> Self

Indicates the beginning of the message.

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

Indicates the beginning of the message.

pub fn byte_length(self, input: i32) -> Self

The length of a message.

This field is required.

pub fn set_byte_length(self, input: Option<i32>) -> Self

The length of a message.

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

The length of a message.

pub fn bit_right_shift(self, input: i32) -> Self

The number of positions to shift bits in the message.

pub fn set_bit_right_shift(self, input: Option<i32>) -> Self

The number of positions to shift bits in the message.

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

The number of positions to shift bits in the message.

pub fn bit_mask_length(self, input: i32) -> Self

The number of bits to mask in a message.

pub fn set_bit_mask_length(self, input: Option<i32>) -> Self

The number of bits to mask in a message.

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

The number of bits to mask in a message.

pub fn is_signed(self, input: bool) -> Self

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 set_is_signed(self, input: Option<bool>) -> Self

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 get_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, input: SignalValueType) -> Self

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

pub fn set_signal_value_type(self, input: Option<SignalValueType>) -> Self

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

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

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

pub fn build(self) -> Result<ObdSignal, BuildError>

Consumes the builder and constructs a ObdSignal. This method will fail if any of the following fields are not set:

• pid_response_length
• scaling
• offset
• byte_length

Trait Implementations

impl Clone for ObdSignalBuilder

fn clone(&self) -> ObdSignalBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObdSignalBuilder

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

Formats the value using the given formatter.

impl Default for ObdSignalBuilder

fn default() -> ObdSignalBuilder

Returns the “default value” for a type.

impl PartialEq for ObdSignalBuilder

fn eq(&self, other: &ObdSignalBuilder) -> 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 ObdSignalBuilder