#[non_exhaustive]pub struct ObdInterfaceBuilder { /* private fields */ }
Expand description
A builder for ObdInterface
.
Implementations§
Source§impl ObdInterfaceBuilder
impl ObdInterfaceBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the interface.
This field is required.Sourcepub fn request_message_id(self, input: i32) -> Self
pub fn request_message_id(self, input: i32) -> Self
The ID of the message requesting vehicle data.
This field is required.Sourcepub fn set_request_message_id(self, input: Option<i32>) -> Self
pub fn set_request_message_id(self, input: Option<i32>) -> Self
The ID of the message requesting vehicle data.
Sourcepub fn get_request_message_id(&self) -> &Option<i32>
pub fn get_request_message_id(&self) -> &Option<i32>
The ID of the message requesting vehicle data.
Sourcepub fn obd_standard(self, input: impl Into<String>) -> Self
pub fn obd_standard(self, input: impl Into<String>) -> Self
The standard OBD II PID.
Sourcepub fn set_obd_standard(self, input: Option<String>) -> Self
pub fn set_obd_standard(self, input: Option<String>) -> Self
The standard OBD II PID.
Sourcepub fn get_obd_standard(&self) -> &Option<String>
pub fn get_obd_standard(&self) -> &Option<String>
The standard OBD II PID.
Sourcepub fn pid_request_interval_seconds(self, input: i32) -> Self
pub fn pid_request_interval_seconds(self, input: i32) -> Self
The maximum number message requests per second.
Sourcepub fn set_pid_request_interval_seconds(self, input: Option<i32>) -> Self
pub fn set_pid_request_interval_seconds(self, input: Option<i32>) -> Self
The maximum number message requests per second.
Sourcepub fn get_pid_request_interval_seconds(&self) -> &Option<i32>
pub fn get_pid_request_interval_seconds(&self) -> &Option<i32>
The maximum number message requests per second.
Sourcepub fn dtc_request_interval_seconds(self, input: i32) -> Self
pub fn dtc_request_interval_seconds(self, input: i32) -> Self
The maximum number message requests per diagnostic trouble code per second.
Sourcepub fn set_dtc_request_interval_seconds(self, input: Option<i32>) -> Self
pub fn set_dtc_request_interval_seconds(self, input: Option<i32>) -> Self
The maximum number message requests per diagnostic trouble code per second.
Sourcepub fn get_dtc_request_interval_seconds(&self) -> &Option<i32>
pub fn get_dtc_request_interval_seconds(&self) -> &Option<i32>
The maximum number message requests per diagnostic trouble code per second.
Sourcepub fn use_extended_ids(self, input: bool) -> Self
pub fn use_extended_ids(self, input: bool) -> Self
Whether to use extended IDs in the message.
Sourcepub fn set_use_extended_ids(self, input: Option<bool>) -> Self
pub fn set_use_extended_ids(self, input: Option<bool>) -> Self
Whether to use extended IDs in the message.
Sourcepub fn get_use_extended_ids(&self) -> &Option<bool>
pub fn get_use_extended_ids(&self) -> &Option<bool>
Whether to use extended IDs in the message.
Sourcepub fn has_transmission_ecu(self, input: bool) -> Self
pub fn has_transmission_ecu(self, input: bool) -> Self
Whether the vehicle has a transmission control module (TCM).
Sourcepub fn set_has_transmission_ecu(self, input: Option<bool>) -> Self
pub fn set_has_transmission_ecu(self, input: Option<bool>) -> Self
Whether the vehicle has a transmission control module (TCM).
Sourcepub fn get_has_transmission_ecu(&self) -> &Option<bool>
pub fn get_has_transmission_ecu(&self) -> &Option<bool>
Whether the vehicle has a transmission control module (TCM).
Sourcepub fn build(self) -> Result<ObdInterface, BuildError>
pub fn build(self) -> Result<ObdInterface, BuildError>
Consumes the builder and constructs a ObdInterface
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ObdInterfaceBuilder
impl Clone for ObdInterfaceBuilder
Source§fn clone(&self) -> ObdInterfaceBuilder
fn clone(&self) -> ObdInterfaceBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ObdInterfaceBuilder
impl Debug for ObdInterfaceBuilder
Source§impl Default for ObdInterfaceBuilder
impl Default for ObdInterfaceBuilder
Source§fn default() -> ObdInterfaceBuilder
fn default() -> ObdInterfaceBuilder
Source§impl PartialEq for ObdInterfaceBuilder
impl PartialEq for ObdInterfaceBuilder
impl StructuralPartialEq for ObdInterfaceBuilder
Auto Trait Implementations§
impl Freeze for ObdInterfaceBuilder
impl RefUnwindSafe for ObdInterfaceBuilder
impl Send for ObdInterfaceBuilder
impl Sync for ObdInterfaceBuilder
impl Unpin for ObdInterfaceBuilder
impl UnwindSafe for ObdInterfaceBuilder
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);