Struct sbp::messages::system::msg_status_journal::MsgStatusJournal

pub struct MsgStatusJournal {
    pub sender_id: Option<u16>,
    pub reporting_system: u16,
    pub sbp_version: u16,
    pub total_status_reports: u32,
    pub sequence_descriptor: u8,
    pub journal: Vec<StatusJournalItem>,
}

Status report journal

The status journal message contains past status reports (see MSG_STATUS_REPORT) and functions as a error/event storage for telemetry purposes.

Fields

sender_id: Option<u16>

The message sender_id

reporting_system: u16

Identity of reporting system

sbp_version: u16

SBP protocol version

total_status_reports: u32

Total number of status reports sent since system startup

sequence_descriptor: u8

Index and number of messages in this sequence. First nibble is the size of the sequence (n), second nibble is the zero-indexed counter (ith packet of n)

journal: Vec<StatusJournalItem>

Status journal

Implementations

impl MsgStatusJournal

pub fn system(&self) -> Result<System, u16>

Gets the System stored in the reporting_system bitfield.

Returns Ok if the bitrange contains a known System variant. Otherwise the value of the bitrange is returned as an Err(u16). This may be because of a malformed message, or because new variants of System were added.

pub fn set_system(&mut self, system: System)

Set the bitrange corresponding to the System of the reporting_system bitfield.

pub fn sbp_major_protocol_version_number(&self) -> u8

Gets the sbp_major_protocol_version_number stored in sbp_version.

pub fn set_sbp_major_protocol_version_number(
    &mut self,
    sbp_major_protocol_version_number: u8
)

Sets the sbp_major_protocol_version_number bitrange of sbp_version.

pub fn sbp_minor_protocol_version_number(&self) -> u8

Gets the sbp_minor_protocol_version_number stored in sbp_version.

pub fn set_sbp_minor_protocol_version_number(
    &mut self,
    sbp_minor_protocol_version_number: u8
)

Sets the sbp_minor_protocol_version_number bitrange of sbp_version.

Trait Implementations

impl Clone for MsgStatusJournal

fn clone(&self) -> MsgStatusJournal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgStatusJournal

const MESSAGE_TYPE: u16 = 65_533u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_STATUS_JOURNAL"

The message name.

impl Debug for MsgStatusJournal

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

Formats the value using the given formatter.

impl From<MsgStatusJournal> for Sbp

fn from(msg: MsgStatusJournal) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgStatusJournal

fn message_name(&self) -> &'static str

Get the message name.

fn message_type(&self) -> u16

Get the message type.

fn sender_id(&self) -> Option<u16>

Get the sender_id if it is set.

fn set_sender_id(&mut self, new_id: u16)

Set the sender id.

fn encoded_len(&self) -> usize

Number of bytes this message will take on the wire.

impl TryFrom<Sbp> for MsgStatusJournal

type Error = TryFromSbpError

The type returned in the event of a conversion error.

fn try_from(msg: Sbp) -> Result<Self, Self::Error>

Performs the conversion.