Struct MessageFrame

pub struct MessageFrame<'a> { /* private fields */ }

Represents the message frame of a RTCM 3.x message.

Holds a reference to the frame data as a slice for valid RTCM message frames, and provides various methods for access to data segment, message number, and CRC24

Implementations

impl<'a> MessageFrame<'a>

pub fn new(frame_data: &'a [u8]) -> Result<Self, RtcmError>

Creates a new MessageFrame from the given frame data.

Parameters:

• frame_data - A slice of bytes representing the frame data.

Errors:

• RtcmError::Incomplete - The given frame data is incomplete.
• RtcmError::NotValid - The given frame data is not valid.

Returns: A MessageFrame if the given data represents a valid RTCM message frame.

pub fn data(&'a self) -> &'a [u8]

Returns the data segment bytes of the RTCM frame as a slice

pub fn frame_data(&'a self) -> &'a [u8]

Returns the bytes of the whole RTCM frame as a slice

pub fn data_len(&self) -> usize

Returns the data segment byte length

pub fn frame_len(&self) -> usize

Returns the RTCM message frame byte length

pub fn crc(&self) -> u32

Returns the RTCM message frame CRC24 checksum

pub fn message_number(&self) -> Option<u16>

Returns the RTCM message number if the frame contains data. Otherwise returns None.

pub fn get_message(&self) -> Message

Decodes the content of the RTCM message frame and returns the result as a Message enum.