Struct EnumDescriptor 

pub struct EnumDescriptor {
    pub name: &'static str,
    pub bitmask: bool,
    pub entries: &'static [EnumEntry],
}

A dialect enumeration: its name, whether its values combine as bits, and every value it names, in the order the dialect lists them.

Fields

name: &'static str

The enumeration’s name, such as "MAV_STATE".

bitmask: bool

Whether a field of this enumeration holds several of its values at once, one per bit.

entries: &'static [EnumEntry]

Every value the enumeration names.

Implementations

impl EnumDescriptor

pub fn value(&self, entry: &str) -> Option<u64>

Returns the value an entry of this enumeration names.

Arguments

• entry - the entry’s name as the dialect writes it, such as "MAV_STATE_STANDBY".

Returns

Some(value), or None if no entry of this enumeration has that name.

Examples

use pamoja_mavlink::dialect::enum_named;

let state = enum_named("MAV_STATE").expect("a dialect enumeration");
assert_eq!(state.value("MAV_STATE_STANDBY"), Some(3));

pub fn entry(&self, value: u64) -> Option<&'static str>

Returns the name of the entry that stands for a value.

Arguments

• value - the value a field carried.

Returns

Some(name) for the first entry, in dialect order, with exactly that value, or None if no entry names it. For a bitmask, see names.

pub fn names(&self, value: u64) -> impl Iterator<Item = &'static str> + '_

Returns the names a value is made of.

Arguments

• value - the value a field carried.

Returns

For a bitmask, each entry whose bits are all set in value, in dialect order, or the entry for zero when value is zero. Otherwise the one entry that names value. Bits or values no entry names are left out.

Examples

use pamoja_mavlink::dialect::{enum_named, mav_mode_flag};

let flags = enum_named("MAV_MODE_FLAG").expect("a dialect enumeration");
let base_mode = mav_mode_flag::SAFETY_ARMED | mav_mode_flag::CUSTOM_MODE_ENABLED;
let names: Vec<&str> = flags.names(u64::from(base_mode)).collect();
assert_eq!(names, ["MAV_MODE_FLAG_SAFETY_ARMED", "MAV_MODE_FLAG_CUSTOM_MODE_ENABLED"]);

Trait Implementations

impl Clone for EnumDescriptor

fn clone(&self) -> EnumDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EnumDescriptor

impl Debug for EnumDescriptor

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

Formats the value using the given formatter.

impl Eq for EnumDescriptor

impl PartialEq for EnumDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EnumDescriptor