Struct Telemetry

#[repr(C)]
pub struct Telemetry<T: Copy> {
    pub payload: T,
    /* private fields */
}

A cFS-flavor CCSDS telemetry packet, as a Rust structure.

Fields

payload: T

The message’s payload. As messages are copied willy-nilly, T needs to be Copy.

Implementations

impl<T: Copy> Telemetry<T>

pub fn new(msg_id: u32, payload: T) -> Result<Self, ()>

If msg_id is a permissible message ID, returns a new Telemetry with the payload initialized to payload; otherwise returns an error.

pub fn new_default(msg_id: u32) -> Result<Self, ()>

where T: Default,

Self::new, but using Default::default() as the payload.

pub fn as_bytes(&self) -> &[u8]

Returns a view of the Telemetry as a sequence of bytes, ready for transmission.

pub unsafe fn from_bytes(bytes: &[u8]) -> Result<Self, ()>

Turns a sequence of bytes representing a message into a Telemetry, assuming bytes is the correct length and the header bytes have sane values.

Safety

Using this function is only safe if the part of bytes at bytes 16..(16 + std::mem::size_of::<T>()) is byte-for-byte equal to a valid item of type T.

pub fn msg_id(&self) -> u32

Returns the message’s message ID.

pub fn timestamp(&self) -> (u32, u16)

Returns the message’s timestamp as a tuple of (seconds since flight-software epoch, subseconds in units of 2⁻¹⁶ s).

pub fn sequence_number(&self) -> u16

Returns the message’s sequence number.

pub fn set_msg_id(&mut self, msg_id: u32) -> Result<(), ()>

If msg_id is a valid message ID, uses it to set the message’s message ID.

pub fn set_timestamp(&mut self, seconds: u64, nanoseconds: u32)

Sets the message’s timestamp to seconds seconds + nanoseconds nanoseconds since the flight-software epoch, rounded to 2⁻¹⁶ seconds.

pub fn timestamp_with_now(&mut self) -> Result<(), SystemTimeError>

Sets the message’s timestamp to the current time.

pub fn increment_sequence_num(&mut self)

Increment the message’s sequence number.

Trait Implementations

impl<T: Clone + Copy> Clone for Telemetry<T>

fn clone(&self) -> Telemetry<T>

Returns a copy of the value.

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

Performs copy-assignment from source.