pub struct MavWinchStatusFlag(/* private fields */);
development
only.Expand description
Winch status flags used in WINCH_STATUS
Implementations§
Source§impl MavWinchStatusFlag
impl MavWinchStatusFlag
Sourcepub const MAV_WINCH_STATUS_HEALTHY: Self
pub const MAV_WINCH_STATUS_HEALTHY: Self
Winch is healthy
Sourcepub const MAV_WINCH_STATUS_FULLY_RETRACTED: Self
pub const MAV_WINCH_STATUS_FULLY_RETRACTED: Self
Winch line is fully retracted
Sourcepub const MAV_WINCH_STATUS_MOVING: Self
pub const MAV_WINCH_STATUS_MOVING: Self
Winch motor is moving
Sourcepub const MAV_WINCH_STATUS_CLUTCH_ENGAGED: Self
pub const MAV_WINCH_STATUS_CLUTCH_ENGAGED: Self
Winch clutch is engaged allowing motor to move freely.
Sourcepub const MAV_WINCH_STATUS_LOCKED: Self
pub const MAV_WINCH_STATUS_LOCKED: Self
Winch is locked by locking mechanism.
Sourcepub const MAV_WINCH_STATUS_DROPPING: Self
pub const MAV_WINCH_STATUS_DROPPING: Self
Winch is gravity dropping payload.
Sourcepub const MAV_WINCH_STATUS_ARRESTING: Self
pub const MAV_WINCH_STATUS_ARRESTING: Self
Winch is arresting payload descent.
Sourcepub const MAV_WINCH_STATUS_GROUND_SENSE: Self
pub const MAV_WINCH_STATUS_GROUND_SENSE: Self
Winch is using torque measurements to sense the ground.
Sourcepub const MAV_WINCH_STATUS_RETRACTING: Self
pub const MAV_WINCH_STATUS_RETRACTING: Self
Winch is returning to the fully retracted position.
Sourcepub const MAV_WINCH_STATUS_REDELIVER: Self
pub const MAV_WINCH_STATUS_REDELIVER: Self
Winch is redelivering the payload. This is a failover state if the line tension goes above a threshold during RETRACTING.
Sourcepub const MAV_WINCH_STATUS_ABANDON_LINE: Self
pub const MAV_WINCH_STATUS_ABANDON_LINE: Self
Winch is abandoning the line and possibly payload. Winch unspools the entire calculated line length. This is a failover state from REDELIVER if the number of attempts exceeds a threshold.
Sourcepub const MAV_WINCH_STATUS_LOCKING: Self
pub const MAV_WINCH_STATUS_LOCKING: Self
Winch is engaging the locking mechanism.
Sourcepub const MAV_WINCH_STATUS_LOAD_LINE: Self
pub const MAV_WINCH_STATUS_LOAD_LINE: Self
Winch is spooling on line.
Sourcepub const MAV_WINCH_STATUS_LOAD_PAYLOAD: Self
pub const MAV_WINCH_STATUS_LOAD_PAYLOAD: Self
Winch is loading a payload.
Source§impl MavWinchStatusFlag
impl MavWinchStatusFlag
Sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> 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 MavWinchStatusFlag
impl MavWinchStatusFlag
Sourcepub const fn iter(&self) -> Iter<MavWinchStatusFlag>
pub const fn iter(&self) -> Iter<MavWinchStatusFlag>
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<MavWinchStatusFlag>
pub const fn iter_names(&self) -> IterNames<MavWinchStatusFlag>
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 MavWinchStatusFlag
impl Binary for MavWinchStatusFlag
Source§impl BitAnd for MavWinchStatusFlag
impl BitAnd for MavWinchStatusFlag
Source§impl BitAndAssign for MavWinchStatusFlag
impl BitAndAssign for MavWinchStatusFlag
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 MavWinchStatusFlag
impl BitOr for MavWinchStatusFlag
Source§fn bitor(self, other: MavWinchStatusFlag) -> Self
fn bitor(self, other: MavWinchStatusFlag) -> Self
The bitwise or (|
) of the bits in two flags values.
Source§type Output = MavWinchStatusFlag
type Output = MavWinchStatusFlag
|
operator.Source§impl BitOrAssign for MavWinchStatusFlag
impl BitOrAssign for MavWinchStatusFlag
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 MavWinchStatusFlag
impl BitXor for MavWinchStatusFlag
Source§impl BitXorAssign for MavWinchStatusFlag
impl BitXorAssign for MavWinchStatusFlag
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 MavWinchStatusFlag
impl Clone for MavWinchStatusFlag
Source§fn clone(&self) -> MavWinchStatusFlag
fn clone(&self) -> MavWinchStatusFlag
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 MavWinchStatusFlag
impl Debug for MavWinchStatusFlag
Source§impl Default for MavWinchStatusFlag
impl Default for MavWinchStatusFlag
Source§impl<'de> Deserialize<'de> for MavWinchStatusFlag
impl<'de> Deserialize<'de> for MavWinchStatusFlag
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<MavWinchStatusFlag> for MavWinchStatusFlag
impl Extend<MavWinchStatusFlag> for MavWinchStatusFlag
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 MavWinchStatusFlag
impl Flags for MavWinchStatusFlag
Source§const FLAGS: &'static [Flag<MavWinchStatusFlag>]
const FLAGS: &'static [Flag<MavWinchStatusFlag>]
Source§fn from_bits_retain(bits: u32) -> MavWinchStatusFlag
fn from_bits_retain(bits: u32) -> MavWinchStatusFlag
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<MavWinchStatusFlag> for MavWinchStatusFlag
impl FromIterator<MavWinchStatusFlag> for MavWinchStatusFlag
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 MavWinchStatusFlag
impl IntoIterator for MavWinchStatusFlag
Source§impl LowerHex for MavWinchStatusFlag
impl LowerHex for MavWinchStatusFlag
Source§impl Not for MavWinchStatusFlag
impl Not for MavWinchStatusFlag
Source§impl Octal for MavWinchStatusFlag
impl Octal for MavWinchStatusFlag
Source§impl PartialEq for MavWinchStatusFlag
impl PartialEq for MavWinchStatusFlag
Source§impl PublicFlags for MavWinchStatusFlag
impl PublicFlags for MavWinchStatusFlag
Source§impl Serialize for MavWinchStatusFlag
impl Serialize for MavWinchStatusFlag
Source§impl Sub for MavWinchStatusFlag
impl Sub for MavWinchStatusFlag
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 = MavWinchStatusFlag
type Output = MavWinchStatusFlag
-
operator.Source§impl SubAssign for MavWinchStatusFlag
impl SubAssign for MavWinchStatusFlag
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.