Struct MessageDescriptorBuilder 

pub struct MessageDescriptorBuilder { /* private fields */ }

Builds a message shape from a definition written the way a dialect reads.

Fields are given in declaration order. MAVLink puts the base fields on the wire largest type first, keeping equal-sized fields in the order declared, and leaves extension fields at the end untouched; build applies that and derives the CRC_EXTRA seed from the result, so a transcription error surfaces as a checksum a peer rejects rather than as silently misread fields.

Implementations

impl MessageDescriptorBuilder

pub fn new(id: u32, name: impl Into<String>) -> Self

Starts a shape for a message id and name.

Arguments

• id - the message id on the wire.
• name - the message name, which the CRC_EXTRA derivation folds in, so it must match the dialect exactly.

Returns

The builder, with no fields yet.

pub fn field( self, name: impl Into<String>, ty: FieldType, array_len: u8, ) -> Self

Adds a base field, in the order the definition declares it.

Arguments

• name - the field name.
• ty - the field’s scalar type, or an array’s element type.
• array_len - the element count for an array, or 0 for a scalar.

Returns

The builder.

pub fn extension( self, name: impl Into<String>, ty: FieldType, array_len: u8, ) -> Self

Adds a MAVLink 2 extension field, in the order the definition declares it.

Extensions keep their declared order, are excluded from the CRC_EXTRA seed, and read as zero from a frame sent by a peer that predates them.

Arguments

• name - the field name.
• ty - the field’s scalar type, or an array’s element type.
• array_len - the element count for an array, or 0 for a scalar.

Returns

The builder.

pub fn build(self) -> Result<OwnedMessageDescriptor>

Puts the fields in wire order and derives the seed.

Returns

The finished shape.

Errors

Returns MavlinkError::DuplicateField if two fields share a name, and MavlinkError::PayloadTooLong if the fields do not fit a MAVLink payload.

Trait Implementations

impl Clone for MessageDescriptorBuilder

fn clone(&self) -> MessageDescriptorBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageDescriptorBuilder

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

Formats the value using the given formatter.

impl Default for MessageDescriptorBuilder

fn default() -> MessageDescriptorBuilder

Returns the “default value” for a type.