#[non_exhaustive]pub struct ObdSignalBuilder { /* private fields */ }Expand description
A builder for ObdSignal.
Implementations§
Source§impl ObdSignalBuilder
impl ObdSignalBuilder
Sourcepub fn pid_response_length(self, input: i32) -> Self
pub fn pid_response_length(self, input: i32) -> Self
The length of the requested data.
This field is required.Sourcepub fn set_pid_response_length(self, input: Option<i32>) -> Self
pub fn set_pid_response_length(self, input: Option<i32>) -> Self
The length of the requested data.
Sourcepub fn get_pid_response_length(&self) -> &Option<i32>
pub fn get_pid_response_length(&self) -> &Option<i32>
The length of the requested data.
Sourcepub fn service_mode(self, input: i32) -> Self
pub fn service_mode(self, input: i32) -> Self
The mode of operation (diagnostic service) in a message.
This field is required.Sourcepub fn set_service_mode(self, input: Option<i32>) -> Self
pub fn set_service_mode(self, input: Option<i32>) -> Self
The mode of operation (diagnostic service) in a message.
Sourcepub fn get_service_mode(&self) -> &Option<i32>
pub fn get_service_mode(&self) -> &Option<i32>
The mode of operation (diagnostic service) in a message.
Sourcepub fn pid(self, input: i32) -> Self
pub fn pid(self, input: i32) -> Self
The diagnostic code used to request data from a vehicle for this signal.
This field is required.Sourcepub fn set_pid(self, input: Option<i32>) -> Self
pub fn set_pid(self, input: Option<i32>) -> Self
The diagnostic code used to request data from a vehicle for this signal.
Sourcepub fn get_pid(&self) -> &Option<i32>
pub fn get_pid(&self) -> &Option<i32>
The diagnostic code used to request data from a vehicle for this signal.
Sourcepub fn scaling(self, input: f64) -> Self
pub fn scaling(self, input: f64) -> Self
A multiplier used to decode the message.
This field is required.Sourcepub fn set_scaling(self, input: Option<f64>) -> Self
pub fn set_scaling(self, input: Option<f64>) -> Self
A multiplier used to decode the message.
Sourcepub fn get_scaling(&self) -> &Option<f64>
pub fn get_scaling(&self) -> &Option<f64>
A multiplier used to decode the message.
Sourcepub fn offset(self, input: f64) -> Self
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.
Sourcepub fn set_offset(self, input: Option<f64>) -> Self
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.
Sourcepub fn get_offset(&self) -> &Option<f64>
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.
Sourcepub fn start_byte(self, input: i32) -> Self
pub fn start_byte(self, input: i32) -> Self
Indicates the beginning of the message.
This field is required.Sourcepub fn set_start_byte(self, input: Option<i32>) -> Self
pub fn set_start_byte(self, input: Option<i32>) -> Self
Indicates the beginning of the message.
Sourcepub fn get_start_byte(&self) -> &Option<i32>
pub fn get_start_byte(&self) -> &Option<i32>
Indicates the beginning of the message.
Sourcepub fn byte_length(self, input: i32) -> Self
pub fn byte_length(self, input: i32) -> Self
The length of a message.
This field is required.Sourcepub fn set_byte_length(self, input: Option<i32>) -> Self
pub fn set_byte_length(self, input: Option<i32>) -> Self
The length of a message.
Sourcepub fn get_byte_length(&self) -> &Option<i32>
pub fn get_byte_length(&self) -> &Option<i32>
The length of a message.
Sourcepub fn bit_right_shift(self, input: i32) -> Self
pub fn bit_right_shift(self, input: i32) -> Self
The number of positions to shift bits in the message.
Sourcepub fn set_bit_right_shift(self, input: Option<i32>) -> Self
pub fn set_bit_right_shift(self, input: Option<i32>) -> Self
The number of positions to shift bits in the message.
Sourcepub fn get_bit_right_shift(&self) -> &Option<i32>
pub fn get_bit_right_shift(&self) -> &Option<i32>
The number of positions to shift bits in the message.
Sourcepub fn bit_mask_length(self, input: i32) -> Self
pub fn bit_mask_length(self, input: i32) -> Self
The number of bits to mask in a message.
Sourcepub fn set_bit_mask_length(self, input: Option<i32>) -> Self
pub fn set_bit_mask_length(self, input: Option<i32>) -> Self
The number of bits to mask in a message.
Sourcepub fn get_bit_mask_length(&self) -> &Option<i32>
pub fn get_bit_mask_length(&self) -> &Option<i32>
The number of bits to mask in a message.
Trait Implementations§
Source§impl Clone for ObdSignalBuilder
impl Clone for ObdSignalBuilder
Source§fn clone(&self) -> ObdSignalBuilder
fn clone(&self) -> ObdSignalBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ObdSignalBuilder
impl Debug for ObdSignalBuilder
Source§impl Default for ObdSignalBuilder
impl Default for ObdSignalBuilder
Source§fn default() -> ObdSignalBuilder
fn default() -> ObdSignalBuilder
Source§impl PartialEq for ObdSignalBuilder
impl PartialEq for ObdSignalBuilder
impl StructuralPartialEq for ObdSignalBuilder
Auto Trait Implementations§
impl Freeze for ObdSignalBuilder
impl RefUnwindSafe for ObdSignalBuilder
impl Send for ObdSignalBuilder
impl Sync for ObdSignalBuilder
impl Unpin for ObdSignalBuilder
impl UnwindSafe for ObdSignalBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);