Struct TypeMask 

pub struct TypeMask(/* private fields */);

Builds a type_mask for a SET_POSITION_TARGET_* message.

A set bit tells the vehicle to ignore that dimension, so the builder starts from ignore_all and each use_* method clears the ignore bits for the dimensions the setpoint provides.

Implementations

impl TypeMask

pub fn ignore_all() -> Self

Starts from a mask that ignores every dimension.

Returns

A mask with every ignore bit set.

pub fn use_position(self) -> Self

Enables the position fields (x, y, z).

Returns

The mask, for chaining.

pub fn use_velocity(self) -> Self

Enables the velocity fields (vx, vy, vz).

Returns

The mask, for chaining.

pub fn use_acceleration(self) -> Self

Enables the acceleration fields (afx, afy, afz).

Returns

The mask, for chaining.

pub fn use_yaw(self) -> Self

Enables the yaw field.

Returns

The mask, for chaining.

pub fn use_yaw_rate(self) -> Self

Enables the yaw_rate field.

Returns

The mask, for chaining.

pub fn force(self) -> Self

Sets the force flag, so the acceleration fields are interpreted as a force.

Returns

The mask, for chaining.

pub fn bits(self) -> u16

Returns the assembled mask value.

Returns

The type_mask bits.

Trait Implementations

impl Clone for TypeMask

fn clone(&self) -> TypeMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TypeMask

impl Debug for TypeMask

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

Formats the value using the given formatter.

impl Eq for TypeMask

impl PartialEq for TypeMask

fn eq(&self, other: &TypeMask) -> 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 StructuralPartialEq for TypeMask