#[non_exhaustive]pub struct CanSignalBuilder { /* private fields */ }Expand description
A builder for CanSignal.
Implementations§
Source§impl CanSignalBuilder
impl CanSignalBuilder
Sourcepub fn message_id(self, input: i32) -> Self
pub fn message_id(self, input: i32) -> Self
The ID of the message.
This field is required.Sourcepub fn set_message_id(self, input: Option<i32>) -> Self
pub fn set_message_id(self, input: Option<i32>) -> Self
The ID of the message.
Sourcepub fn get_message_id(&self) -> &Option<i32>
pub fn get_message_id(&self) -> &Option<i32>
The ID of the message.
Sourcepub fn is_big_endian(self, input: bool) -> Self
pub fn is_big_endian(self, input: bool) -> Self
Whether the byte ordering of a CAN message is big-endian.
This field is required.Sourcepub fn set_is_big_endian(self, input: Option<bool>) -> Self
pub fn set_is_big_endian(self, input: Option<bool>) -> Self
Whether the byte ordering of a CAN message is big-endian.
Sourcepub fn get_is_big_endian(&self) -> &Option<bool>
pub fn get_is_big_endian(&self) -> &Option<bool>
Whether the byte ordering of a CAN message is big-endian.
Sourcepub fn is_signed(self, input: bool) -> Self
pub fn is_signed(self, input: bool) -> Self
Whether the message data is specified as a signed value.
This field is required.Sourcepub fn set_is_signed(self, input: Option<bool>) -> Self
pub fn set_is_signed(self, input: Option<bool>) -> Self
Whether the message data is specified as a signed value.
Sourcepub fn get_is_signed(&self) -> &Option<bool>
pub fn get_is_signed(&self) -> &Option<bool>
Whether the message data is specified as a signed value.
Sourcepub fn start_bit(self, input: i32) -> Self
pub fn start_bit(self, input: i32) -> Self
Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
Sourcepub fn set_start_bit(self, input: Option<i32>) -> Self
pub fn set_start_bit(self, input: Option<i32>) -> Self
Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
Sourcepub fn get_start_bit(&self) -> &Option<i32>
pub fn get_start_bit(&self) -> &Option<i32>
Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
Sourcepub fn offset(self, input: f64) -> Self
pub fn offset(self, input: f64) -> Self
The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + 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 factor, the calculation is value = raw_value * factor + 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 factor, the calculation is value = raw_value * factor + offset.
Sourcepub fn factor(self, input: f64) -> Self
pub fn factor(self, input: f64) -> Self
A multiplier used to decode the CAN message.
This field is required.Sourcepub fn set_factor(self, input: Option<f64>) -> Self
pub fn set_factor(self, input: Option<f64>) -> Self
A multiplier used to decode the CAN message.
Sourcepub fn get_factor(&self) -> &Option<f64>
pub fn get_factor(&self) -> &Option<f64>
A multiplier used to decode the CAN message.
Sourcepub fn length(self, input: i32) -> Self
pub fn length(self, input: i32) -> Self
How many bytes of data are in the message.
This field is required.Sourcepub fn set_length(self, input: Option<i32>) -> Self
pub fn set_length(self, input: Option<i32>) -> Self
How many bytes of data are in the message.
Sourcepub fn get_length(&self) -> &Option<i32>
pub fn get_length(&self) -> &Option<i32>
How many bytes of data are in the message.
Trait Implementations§
Source§impl Clone for CanSignalBuilder
impl Clone for CanSignalBuilder
Source§fn clone(&self) -> CanSignalBuilder
fn clone(&self) -> CanSignalBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CanSignalBuilder
impl Debug for CanSignalBuilder
Source§impl Default for CanSignalBuilder
impl Default for CanSignalBuilder
Source§fn default() -> CanSignalBuilder
fn default() -> CanSignalBuilder
Source§impl PartialEq for CanSignalBuilder
impl PartialEq for CanSignalBuilder
impl StructuralPartialEq for CanSignalBuilder
Auto Trait Implementations§
impl Freeze for CanSignalBuilder
impl RefUnwindSafe for CanSignalBuilder
impl Send for CanSignalBuilder
impl Sync for CanSignalBuilder
impl Unpin for CanSignalBuilder
impl UnwindSafe for CanSignalBuilder
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);