pub struct EkfStatusFlags(/* private fields */);
storm32
only.Expand description
Flags in EKF_STATUS message.
Implementations§
Source§impl EkfStatusFlags
impl EkfStatusFlags
Sourcepub const EKF_ATTITUDE: Self
pub const EKF_ATTITUDE: Self
Set if EKF’s attitude estimate is good.
Sourcepub const EKF_VELOCITY_HORIZ: Self
pub const EKF_VELOCITY_HORIZ: Self
Set if EKF’s horizontal velocity estimate is good.
Sourcepub const EKF_VELOCITY_VERT: Self
pub const EKF_VELOCITY_VERT: Self
Set if EKF’s vertical velocity estimate is good.
Sourcepub const EKF_POS_HORIZ_REL: Self
pub const EKF_POS_HORIZ_REL: Self
Set if EKF’s horizontal position (relative) estimate is good.
Sourcepub const EKF_POS_HORIZ_ABS: Self
pub const EKF_POS_HORIZ_ABS: Self
Set if EKF’s horizontal position (absolute) estimate is good.
Sourcepub const EKF_POS_VERT_ABS: Self
pub const EKF_POS_VERT_ABS: Self
Set if EKF’s vertical position (absolute) estimate is good.
Sourcepub const EKF_POS_VERT_AGL: Self
pub const EKF_POS_VERT_AGL: Self
Set if EKF’s vertical position (above ground) estimate is good.
Sourcepub const EKF_CONST_POS_MODE: Self
pub const EKF_CONST_POS_MODE: Self
EKF is in constant position mode and does not know it’s absolute or relative position.
Sourcepub const EKF_PRED_POS_HORIZ_REL: Self
pub const EKF_PRED_POS_HORIZ_REL: Self
Set if EKF’s predicted horizontal position (relative) estimate is good.
Sourcepub const EKF_PRED_POS_HORIZ_ABS: Self
pub const EKF_PRED_POS_HORIZ_ABS: Self
Set if EKF’s predicted horizontal position (absolute) estimate is good.
Sourcepub const EKF_GPS_GLITCHING: Self
pub const EKF_GPS_GLITCHING: Self
Set if EKF believes the GPS input data is faulty.
Sourcepub const EKF_UNINITIALIZED: Self
pub const EKF_UNINITIALIZED: Self
Set if EKF has never been healthy.
Source§impl EkfStatusFlags
impl EkfStatusFlags
Sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl EkfStatusFlags
impl EkfStatusFlags
Sourcepub const fn iter(&self) -> Iter<EkfStatusFlags>
pub const fn iter(&self) -> Iter<EkfStatusFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
Sourcepub const fn iter_names(&self) -> IterNames<EkfStatusFlags>
pub const fn iter_names(&self) -> IterNames<EkfStatusFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
Source§impl Binary for EkfStatusFlags
impl Binary for EkfStatusFlags
Source§impl BitAnd for EkfStatusFlags
impl BitAnd for EkfStatusFlags
Source§impl BitAndAssign for EkfStatusFlags
impl BitAndAssign for EkfStatusFlags
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for EkfStatusFlags
impl BitOr for EkfStatusFlags
Source§fn bitor(self, other: EkfStatusFlags) -> Self
fn bitor(self, other: EkfStatusFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
Source§type Output = EkfStatusFlags
type Output = EkfStatusFlags
|
operator.Source§impl BitOrAssign for EkfStatusFlags
impl BitOrAssign for EkfStatusFlags
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for EkfStatusFlags
impl BitXor for EkfStatusFlags
Source§impl BitXorAssign for EkfStatusFlags
impl BitXorAssign for EkfStatusFlags
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for EkfStatusFlags
impl Clone for EkfStatusFlags
Source§fn clone(&self) -> EkfStatusFlags
fn clone(&self) -> EkfStatusFlags
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 EkfStatusFlags
impl Debug for EkfStatusFlags
Source§impl Default for EkfStatusFlags
impl Default for EkfStatusFlags
Source§impl<'de> Deserialize<'de> for EkfStatusFlags
impl<'de> Deserialize<'de> for EkfStatusFlags
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Extend<EkfStatusFlags> for EkfStatusFlags
impl Extend<EkfStatusFlags> for EkfStatusFlags
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Source§impl Flags for EkfStatusFlags
impl Flags for EkfStatusFlags
Source§const FLAGS: &'static [Flag<EkfStatusFlags>]
const FLAGS: &'static [Flag<EkfStatusFlags>]
Source§fn from_bits_retain(bits: u16) -> EkfStatusFlags
fn from_bits_retain(bits: u16) -> EkfStatusFlags
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.Source§impl FromIterator<EkfStatusFlags> for EkfStatusFlags
impl FromIterator<EkfStatusFlags> for EkfStatusFlags
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
Source§impl IntoIterator for EkfStatusFlags
impl IntoIterator for EkfStatusFlags
Source§impl LowerHex for EkfStatusFlags
impl LowerHex for EkfStatusFlags
Source§impl Not for EkfStatusFlags
impl Not for EkfStatusFlags
Source§impl Octal for EkfStatusFlags
impl Octal for EkfStatusFlags
Source§impl PartialEq for EkfStatusFlags
impl PartialEq for EkfStatusFlags
Source§impl PublicFlags for EkfStatusFlags
impl PublicFlags for EkfStatusFlags
Source§impl Serialize for EkfStatusFlags
impl Serialize for EkfStatusFlags
Source§impl Sub for EkfStatusFlags
impl Sub for EkfStatusFlags
Source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§type Output = EkfStatusFlags
type Output = EkfStatusFlags
-
operator.Source§impl SubAssign for EkfStatusFlags
impl SubAssign for EkfStatusFlags
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.