#[non_exhaustive]pub enum SignalDecoderFailureReason {
Show 17 variants
CanSignalInfoIsNull,
ConflictingSignal,
CustomDecodingSignalInfoIsNull,
DuplicateSignal,
EmptyMessageSignal,
MessageSignalInfoIsNull,
NetworkInterfaceTypeIncompatibleWithSignalDecoderType,
NoDecoderInfoForSignalInModel,
NoSignalInCatalogForDecoderSignal,
ObdSignalInfoIsNull,
SignalDecoderIncompatibleWithSignalCatalog,
SignalDecoderTypeIncompatibleWithMessageSignalType,
SignalNotAssociatedWithNetworkInterface,
SignalNotInModel,
SignalToAddAlreadyExists,
StructSizeMismatch,
Unknown(UnknownVariantValue),
}
Expand description
When writing a match expression against SignalDecoderFailureReason
, it is important to ensure
your code is forward-compatible. That is, if a match arm handles a case for a
feature that is supported by the service but has not been represented as an enum
variant in a current version of SDK, your code should continue to work when you
upgrade SDK to a future version in which the enum does include a variant for that
feature.
Here is an example of how you can make a match expression forward-compatible:
# let signaldecoderfailurereason = unimplemented!();
match signaldecoderfailurereason {
SignalDecoderFailureReason::CanSignalInfoIsNull => { /* ... */ },
SignalDecoderFailureReason::ConflictingSignal => { /* ... */ },
SignalDecoderFailureReason::CustomDecodingSignalInfoIsNull => { /* ... */ },
SignalDecoderFailureReason::DuplicateSignal => { /* ... */ },
SignalDecoderFailureReason::EmptyMessageSignal => { /* ... */ },
SignalDecoderFailureReason::MessageSignalInfoIsNull => { /* ... */ },
SignalDecoderFailureReason::NetworkInterfaceTypeIncompatibleWithSignalDecoderType => { /* ... */ },
SignalDecoderFailureReason::NoDecoderInfoForSignalInModel => { /* ... */ },
SignalDecoderFailureReason::NoSignalInCatalogForDecoderSignal => { /* ... */ },
SignalDecoderFailureReason::ObdSignalInfoIsNull => { /* ... */ },
SignalDecoderFailureReason::SignalDecoderIncompatibleWithSignalCatalog => { /* ... */ },
SignalDecoderFailureReason::SignalDecoderTypeIncompatibleWithMessageSignalType => { /* ... */ },
SignalDecoderFailureReason::SignalNotAssociatedWithNetworkInterface => { /* ... */ },
SignalDecoderFailureReason::SignalNotInModel => { /* ... */ },
SignalDecoderFailureReason::SignalToAddAlreadyExists => { /* ... */ },
SignalDecoderFailureReason::StructSizeMismatch => { /* ... */ },
other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
_ => { /* ... */ },
}
The above code demonstrates that when signaldecoderfailurereason
represents
NewFeature
, the execution path will lead to the second last match arm,
even though the enum does not contain a variant SignalDecoderFailureReason::NewFeature
in the current version of SDK. The reason is that the variable other
,
created by the @
operator, is bound to
SignalDecoderFailureReason::Unknown(UnknownVariantValue("NewFeature".to_owned()))
and calling as_str
on it yields "NewFeature"
.
This match expression is forward-compatible when executed with a newer
version of SDK where the variant SignalDecoderFailureReason::NewFeature
is defined.
Specifically, when signaldecoderfailurereason
represents NewFeature
,
the execution path will hit the second last match arm as before by virtue of
calling as_str
on SignalDecoderFailureReason::NewFeature
also yielding "NewFeature"
.
Explicitly matching on the Unknown
variant should
be avoided for two reasons:
- The inner data
UnknownVariantValue
is opaque, and no further information can be extracted. - It might inadvertently shadow other intended match arms.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
CanSignalInfoIsNull
ConflictingSignal
CustomDecodingSignalInfoIsNull
DuplicateSignal
EmptyMessageSignal
MessageSignalInfoIsNull
NetworkInterfaceTypeIncompatibleWithSignalDecoderType
NoDecoderInfoForSignalInModel
NoSignalInCatalogForDecoderSignal
ObdSignalInfoIsNull
SignalDecoderIncompatibleWithSignalCatalog
SignalDecoderTypeIncompatibleWithMessageSignalType
SignalNotAssociatedWithNetworkInterface
SignalNotInModel
SignalToAddAlreadyExists
StructSizeMismatch
Unknown(UnknownVariantValue)
Unknown
. See the docs on this enum for the correct way to handle unknown variants.Unknown
contains new variants that have been added since this code was generated.
Implementations§
Source§impl SignalDecoderFailureReason
impl SignalDecoderFailureReason
Sourcepub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
Parses the enum value while disallowing unknown variants.
Unknown variants will result in an error.
Trait Implementations§
Source§impl AsRef<str> for SignalDecoderFailureReason
impl AsRef<str> for SignalDecoderFailureReason
Source§impl Clone for SignalDecoderFailureReason
impl Clone for SignalDecoderFailureReason
Source§fn clone(&self) -> SignalDecoderFailureReason
fn clone(&self) -> SignalDecoderFailureReason
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SignalDecoderFailureReason
impl Debug for SignalDecoderFailureReason
Source§impl Display for SignalDecoderFailureReason
impl Display for SignalDecoderFailureReason
Source§impl From<&str> for SignalDecoderFailureReason
impl From<&str> for SignalDecoderFailureReason
Source§impl FromStr for SignalDecoderFailureReason
impl FromStr for SignalDecoderFailureReason
Source§impl Hash for SignalDecoderFailureReason
impl Hash for SignalDecoderFailureReason
Source§impl Ord for SignalDecoderFailureReason
impl Ord for SignalDecoderFailureReason
Source§fn cmp(&self, other: &SignalDecoderFailureReason) -> Ordering
fn cmp(&self, other: &SignalDecoderFailureReason) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialOrd for SignalDecoderFailureReason
impl PartialOrd for SignalDecoderFailureReason
impl Eq for SignalDecoderFailureReason
impl StructuralPartialEq for SignalDecoderFailureReason
Auto Trait Implementations§
impl Freeze for SignalDecoderFailureReason
impl RefUnwindSafe for SignalDecoderFailureReason
impl Send for SignalDecoderFailureReason
impl Sync for SignalDecoderFailureReason
impl Unpin for SignalDecoderFailureReason
impl UnwindSafe for SignalDecoderFailureReason
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<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.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);