Struct sbp::messages::ext_events::msg_ext_event::MsgExtEvent

pub struct MsgExtEvent {
    pub sender_id: Option<u16>,
    pub wn: u16,
    pub tow: u32,
    pub ns_residual: i32,
    pub flags: u8,
    pub pin: u8,
}

Reports timestamped external pin event

Reports detection of an external event, the GPS time it occurred, which pin it was and whether it was rising or falling.

Fields

sender_id: Option<u16>

The message sender_id

wn: u16

GPS week number

tow: u32

GPS time of week rounded to the nearest millisecond

ns_residual: i32

Nanosecond residual of millisecond-rounded TOW (ranges from -500000 to 500000)

flags: u8

Flags

pin: u8

Pin number. 0..9 = DEBUG0..9.

Implementations

impl MsgExtEvent

pub fn time_quality(&self) -> Result<TimeQuality, u8>

Gets the TimeQuality stored in the flags bitfield.

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

pub fn set_time_quality(&mut self, time_quality: TimeQuality)

Set the bitrange corresponding to the TimeQuality of the flags bitfield.

pub fn new_level_of_pin(&self) -> Result<NewLevelOfPin, u8>

Gets the NewLevelOfPin stored in the flags bitfield.

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

pub fn set_new_level_of_pin(&mut self, new_level_of_pin: NewLevelOfPin)

Set the bitrange corresponding to the NewLevelOfPin of the flags bitfield.

Trait Implementations

impl Clone for MsgExtEvent

fn clone(&self) -> MsgExtEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgExtEvent

const MESSAGE_TYPE: u16 = 257u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_EXT_EVENT"

The message name.

impl Debug for MsgExtEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MsgExtEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FriendlyName for MsgExtEvent

fn friendly_name() -> &'static str

impl From<MsgExtEvent> for Sbp

fn from(msg: MsgExtEvent) -> Self

Converts to this type from the input type.

impl PartialEq for MsgExtEvent

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SbpMessage for MsgExtEvent

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

Get the message name.

fn message_type(&self) -> Option<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.

fn is_valid(&self) -> bool

Tells you if the message is valid or if it is not a valid message and may need to be special cased at certain points.

fn into_valid_msg(self) -> Result<Self, Invalid>

fn gps_time(&self) -> Option<Result<MessageTime, GpsTimeError>>

Get the GPS time associated with the message.

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

Get friendly name associated with the message.

impl Serialize for MsgExtEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Sbp> for MsgExtEvent

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.

impl StructuralPartialEq for MsgExtEvent