Struct arinc_429::Message

pub struct Message(_);

An ARINC 429 message

The bits of a message are represented exactly as transmitted on the wires, with the least significant bit transmitted first.

The label field is in the 8 least significant bits. Because the most significant digit of the label is transmitted first, the label field is in the reverse of the usual bit order.

The parity bit is the most significant bit.

Conversions

The u32::from(Message) and Message::from(u32) From implementations copy bits with no changes.

Some ARINC 429 adapters use a different representation, where the bits of the label field are reversed from their on-wire representation. The methods Message::from_bits_label_swapped() and Message::bits_label_swapped() implement this conversion.

Conversions never panic.

Examples

Create a message

let message = Message::from(0x10000056);
assert_eq!(0x10000056, u32::from(message));

Label bit swapping

let message = Message::from_bits_label_swapped(0x10000056);
assert_eq!(0x1000006a, u32::from(message));

Methods

impl Message

pub fn bits(&self) -> u32

Returns the bits that represent this message

pub fn bits_label_swapped(&self) -> u32

Returns the bits of this message, but with the order of the 8 label bits reversed.

pub fn from_bits_label_swapped(bits: u32) -> Self

Creates a message from a message representation with the 8 label bits reversed. The returned Message will be represented as transmitted on the wires.

pub fn check_parity(&self) -> Result<(), ParityError>

Checks the parity of this message, and returns an error if the parity is not odd

Examples

assert!(Message::from(0x0).check_parity().is_err());
assert!(Message::from(0xf03ccccc).check_parity().is_err());
assert!(Message::from(0x1).check_parity().is_ok());
assert!(Message::from(0xf13ccccc).check_parity().is_ok());

pub fn update_parity(&self) -> Message

Calculates the parity of this message and returns a new message with the parity bit (31) to the correct value

Examples

// Create a message with incorrect (even) parity
let message = Message::from(0x22443300);
assert_eq!(message.update_parity().bits(), 0xa2443300);

// Create a message with correct (odd) parity
let message = Message::from(0x22443301);
// Message should not change
assert_eq!(message.update_parity(), message);

pub fn label(&self) -> Label

Returns the label of this message. This can be used to show the label as an octal number.

Examples

let message = Message::from(0x84000109);
let label = message.label();
assert_eq!(format!("{:?}", label), "Label(0o220)");

let message = Message::from(0x84000180);
let label = message.label();
assert_eq!(format!("{:?}", label), "Label(0o001)");

Trait Implementations

impl From<u32> for Message

fn from(bits: u32) -> Self

Creates a message from bits as transmitted, with no modifications

impl From<Message> for u32

fn from(Message: Message) -> u32

Converts a message into bits, with no modifications

impl Default for Message

fn default() -> Message

Returns the "default value" for a type.

impl PartialEq<Message> for Message

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Message> for Message

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Message

impl Copy for Message

impl Ord for Message

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Hash for Message

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, 

Feeds a slice of this type into the given [Hasher].