Struct mavlink::common::MavWinchStatusFlag
source · pub struct MavWinchStatusFlag { /* private fields */ }
common
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.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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
.
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)
Disables all flags disabled in the set.
source§impl BitOr for MavWinchStatusFlag
impl BitOr for MavWinchStatusFlag
source§fn bitor(self, other: MavWinchStatusFlag) -> Self
fn bitor(self, other: MavWinchStatusFlag) -> Self
Returns the union of the two sets of flags.
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)
Adds the set of flags.
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)
Toggles the set of flags.
source§impl Clone for MavWinchStatusFlag
impl Clone for MavWinchStatusFlag
source§fn clone(&self) -> MavWinchStatusFlag
fn clone(&self) -> MavWinchStatusFlag
1.0.0 · source§fn clone_from(&mut self, source: &Self)
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)
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 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
source§impl Hash for MavWinchStatusFlag
impl Hash 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 Ord for MavWinchStatusFlag
impl Ord for MavWinchStatusFlag
source§fn cmp(&self, other: &MavWinchStatusFlag) -> Ordering
fn cmp(&self, other: &MavWinchStatusFlag) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for MavWinchStatusFlag
impl PartialEq for MavWinchStatusFlag
source§impl PartialOrd for MavWinchStatusFlag
impl PartialOrd for MavWinchStatusFlag
source§impl Serialize for MavWinchStatusFlag
impl Serialize for MavWinchStatusFlag
source§impl Sub for MavWinchStatusFlag
impl Sub for MavWinchStatusFlag
source§impl SubAssign for MavWinchStatusFlag
impl SubAssign for MavWinchStatusFlag
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for MavWinchStatusFlag
impl UpperHex for MavWinchStatusFlag
impl Copy for MavWinchStatusFlag
impl Eq for MavWinchStatusFlag
impl StructuralPartialEq for MavWinchStatusFlag
Auto Trait Implementations§
impl Freeze for MavWinchStatusFlag
impl RefUnwindSafe for MavWinchStatusFlag
impl Send for MavWinchStatusFlag
impl Sync for MavWinchStatusFlag
impl Unpin for MavWinchStatusFlag
impl UnwindSafe for MavWinchStatusFlag
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)