Struct clyde_3g_eps_api::StatusCode
source · [−]pub struct StatusCode { /* private fields */ }
Expand description
EPS Board Status Codes
Implementations
sourceimpl StatusCode
impl StatusCode
sourcepub const LAST_COMMAND_FAILED: Self = _
pub const LAST_COMMAND_FAILED: Self = _
Last Command Failed
sourcepub const WATCHDOG_ERROR: Self = _
pub const WATCHDOG_ERROR: Self = _
Watchdog Error
sourcepub const BAD_COMMAND_DATA: Self = _
pub const BAD_COMMAND_DATA: Self = _
Bad Command Data
sourcepub const BAD_COMMAND_CHANNEL: Self = _
pub const BAD_COMMAND_CHANNEL: Self = _
Bad Command Channel
sourcepub const ERROR_READING_EEPROM: Self = _
pub const ERROR_READING_EEPROM: Self = _
Error Reading EEPROM
sourcepub const POWER_ON_RESET: Self = _
pub const POWER_ON_RESET: Self = _
Power On Reset
sourcepub const BROWN_OUT_RESET: Self = _
pub const BROWN_OUT_RESET: Self = _
Brown Out Reset
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
sourceimpl StatusCode
impl StatusCode
sourcepub fn to_vec(self) -> Vec<String>
pub fn to_vec(self) -> Vec<String>
Convert the flags byte into a vector containing the string representations of all flags present.
Examples
use eps_api::EpsResult;
use clyde_3g_eps_api::*;
let flags = StatusCode::BAD_COMMAND_DATA | StatusCode::POWER_ON_RESET;
let conv = flags.to_vec();
assert_eq!(conv, vec!["BAD_COMMAND_DATA", "POWER_ON_RESET"]);
Trait Implementations
sourceimpl Binary for StatusCode
impl Binary for StatusCode
sourceimpl BitAnd<StatusCode> for StatusCode
impl BitAnd<StatusCode> for StatusCode
type Output = StatusCode
type Output = StatusCode
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<StatusCode> for StatusCode
impl BitAndAssign<StatusCode> for StatusCode
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<StatusCode> for StatusCode
impl BitOr<StatusCode> for StatusCode
sourcefn bitor(self, other: StatusCode) -> Self
fn bitor(self, other: StatusCode) -> Self
Returns the union of the two sets of flags.
type Output = StatusCode
type Output = StatusCode
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<StatusCode> for StatusCode
impl BitOrAssign<StatusCode> for StatusCode
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<StatusCode> for StatusCode
impl BitXor<StatusCode> for StatusCode
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = StatusCode
type Output = StatusCode
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<StatusCode> for StatusCode
impl BitXorAssign<StatusCode> for StatusCode
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for StatusCode
impl Clone for StatusCode
sourcefn clone(&self) -> StatusCode
fn clone(&self) -> StatusCode
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StatusCode
impl Debug for StatusCode
sourceimpl Default for StatusCode
impl Default for StatusCode
sourcefn default() -> StatusCode
fn default() -> StatusCode
Returns the “default value” for a type. Read more
sourceimpl Extend<StatusCode> for StatusCode
impl Extend<StatusCode> for StatusCode
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<StatusCode> for StatusCode
impl FromIterator<StatusCode> for StatusCode
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for StatusCode
impl Hash for StatusCode
sourceimpl LowerHex for StatusCode
impl LowerHex for StatusCode
sourceimpl Not for StatusCode
impl Not for StatusCode
type Output = StatusCode
type Output = StatusCode
The resulting type after applying the !
operator.
sourceimpl Octal for StatusCode
impl Octal for StatusCode
sourceimpl Ord for StatusCode
impl Ord for StatusCode
sourcefn cmp(&self, other: &StatusCode) -> Ordering
fn cmp(&self, other: &StatusCode) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<StatusCode> for StatusCode
impl PartialEq<StatusCode> for StatusCode
sourcefn eq(&self, other: &StatusCode) -> bool
fn eq(&self, other: &StatusCode) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StatusCode) -> bool
fn ne(&self, other: &StatusCode) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StatusCode> for StatusCode
impl PartialOrd<StatusCode> for StatusCode
sourcefn partial_cmp(&self, other: &StatusCode) -> Option<Ordering>
fn partial_cmp(&self, other: &StatusCode) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<StatusCode> for StatusCode
impl Sub<StatusCode> for StatusCode
type Output = StatusCode
type Output = StatusCode
The resulting type after applying the -
operator.
sourceimpl SubAssign<StatusCode> for StatusCode
impl SubAssign<StatusCode> for StatusCode
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for StatusCode
impl UpperHex for StatusCode
impl Copy for StatusCode
impl Eq for StatusCode
impl StructuralEq for StatusCode
impl StructuralPartialEq for StatusCode
Auto Trait Implementations
impl RefUnwindSafe for StatusCode
impl Send for StatusCode
impl Sync for StatusCode
impl Unpin for StatusCode
impl UnwindSafe for StatusCode
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more