Struct mavlink::common::GimbalDeviceCapFlags

pub struct GimbalDeviceCapFlags { /* private fields */ }

Available on crate feature common only.

Gimbal device (low level) capability flags (bitmap).

Implementations

impl GimbalDeviceCapFlags

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_RETRACT: Self = _

Gimbal device supports a retracted position.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_NEUTRAL: Self = _

Gimbal device supports a horizontal, forward looking position, stabilized.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_ROLL_AXIS: Self = _

Gimbal device supports rotating around roll axis.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_ROLL_FOLLOW: Self = _

Gimbal device supports to follow a roll angle relative to the vehicle.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_ROLL_LOCK: Self = _

Gimbal device supports locking to a roll angle (generally that’s the default with roll stabilized).

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_PITCH_AXIS: Self = _

Gimbal device supports rotating around pitch axis.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_PITCH_FOLLOW: Self = _

Gimbal device supports to follow a pitch angle relative to the vehicle.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_PITCH_LOCK: Self = _

Gimbal device supports locking to a pitch angle (generally that’s the default with pitch stabilized).

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_YAW_AXIS: Self = _

Gimbal device supports rotating around yaw axis.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_YAW_FOLLOW: Self = _

Gimbal device supports to follow a yaw angle relative to the vehicle (generally that’s the default).

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_YAW_LOCK: Self = _

Gimbal device supports locking to an absolute heading, i.e., yaw angle relative to North (earth frame, often this is an option available).

pub const GIMBAL_DEVICE_CAP_FLAGS_SUPPORTS_INFINITE_YAW: Self = _

Gimbal device supports yawing/panning infinetely (e.g. using slip disk).

pub const GIMBAL_DEVICE_CAP_FLAGS_SUPPORTS_YAW_IN_EARTH_FRAME: Self = _

Gimbal device supports yaw angles and angular velocities relative to North (earth frame). This usually requires support by an autopilot via AUTOPILOT_STATE_FOR_GIMBAL_DEVICE. Support can go on and off during runtime, which is reported by the flag GIMBAL_DEVICE_FLAGS_CAN_ACCEPT_YAW_IN_EARTH_FRAME.

pub const GIMBAL_DEVICE_CAP_FLAGS_HAS_RC_INPUTS: Self = _

Gimbal device supports radio control inputs as an alternative input for controlling the gimbal orientation.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u16) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u16) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u16) -> 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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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.

impl GimbalDeviceCapFlags

pub const DEFAULT: Self = Self::GIMBAL_DEVICE_CAP_FLAGS_HAS_RETRACT

Trait Implementations

impl Binary for GimbalDeviceCapFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for GimbalDeviceCapFlags

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = GimbalDeviceCapFlags

The resulting type after applying the & operator.

impl BitAndAssign for GimbalDeviceCapFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for GimbalDeviceCapFlags

fn bitor(self, other: GimbalDeviceCapFlags) -> Self

Returns the union of the two sets of flags.

type Output = GimbalDeviceCapFlags

The resulting type after applying the | operator.

impl BitOrAssign for GimbalDeviceCapFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for GimbalDeviceCapFlags

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = GimbalDeviceCapFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for GimbalDeviceCapFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for GimbalDeviceCapFlags

fn clone(&self) -> GimbalDeviceCapFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GimbalDeviceCapFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GimbalDeviceCapFlags

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GimbalDeviceCapFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<GimbalDeviceCapFlags> for GimbalDeviceCapFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<GimbalDeviceCapFlags> for GimbalDeviceCapFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for GimbalDeviceCapFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for GimbalDeviceCapFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for GimbalDeviceCapFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = GimbalDeviceCapFlags

The resulting type after applying the ! operator.

impl Octal for GimbalDeviceCapFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for GimbalDeviceCapFlags

fn cmp(&self, other: &GimbalDeviceCapFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GimbalDeviceCapFlags

fn eq(&self, other: &GimbalDeviceCapFlags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GimbalDeviceCapFlags

fn partial_cmp(&self, other: &GimbalDeviceCapFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GimbalDeviceCapFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for GimbalDeviceCapFlags

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = GimbalDeviceCapFlags

The resulting type after applying the - operator.

impl SubAssign for GimbalDeviceCapFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for GimbalDeviceCapFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for GimbalDeviceCapFlags

impl Eq for GimbalDeviceCapFlags

impl StructuralPartialEq for GimbalDeviceCapFlags